Skip to main content

GenerateUpdateApiKeyResponseModel

statusboolean

Whether the request succeeded.

Example: false
messagestring

Human-readable description of the result.

Example: Maximum API key limit reached
api_key object

API key returned by the request.

idinteger

Unique numeric identifier for the API key.

Example: 3287
namestring

Name of the API key.

Example: api-example-key
descriptionstring

Description of the API key.

Example:
keystring

API key value used to authenticate API requests.

Example: ********-****-****-****-********be9a
created_atstring<date-time>

ISO 8601 UTC timestamp marking when the API key was created.

Example: 2026-05-06T16:04:09Z
GenerateUpdateApiKeyResponseModel
{
"status": false,
"message": "Maximum API key limit reached",
"api_key": {
"id": 3287,
"name": "api-example-key",
"description": "",
"key": "********-****-****-****-********be9a",
"created_at": "2026-05-06T16:04:09Z"
}
}