ConflictError

statusintegerrequiredread-only

The HTTP status code of the error. Useful when passing the response
body to child properties in a frontend UI. Must be returned as an integer.

Example:409

titlestringrequiredread-only

A short, human-readable summary of the problem. It should not
change between occurences of a problem, except for localization.
Should be provided as “Sentence case” for direct use in the UI.

Example:Conflict

typestringread-only

The error type.

Example:https://httpstatuses.com/409

instancestringrequiredread-only

Used to return the correlation ID back to the user, in the format
kong:trace:<correlation_id>. This helps us find the relevant logs
when a customer reports an issue.

Example:kong:trace:1234567890

detailstringrequiredread-only

A human readable explanation specific to this occurence of the problem.
This field may contain request/entity data to help the user understand
what went wrong. Enclose variable values in square brackets. Should be
provided as “Sentence case” for direct use in the UI.

Example:Conflict

Example

TooManyRequestsError

statusintegerrequiredread-only

The HTTP status code of the error. Useful when passing the response
body to child properties in a frontend UI. Must be returned as an integer.

Example:429

titlestringrequiredread-only

A short, human-readable summary of the problem. It should not
change between occurences of a problem, except for localization.
Should be provided as “Sentence case” for direct use in the UI.

Example:Too Many Requests

typestringread-only

The error type.

Example:https://httpstatuses.com/429

instancestringrequiredread-only

Used to return the correlation ID back to the user, in the format
kong:trace:<correlation_id>. This helps us find the relevant logs
when a customer reports an issue.

Example:kong:trace:1234567890

detailstringrequiredread-only

A human readable explanation specific to this occurence of the problem.
This field may contain request/entity data to help the user understand
what went wrong. Enclose variable values in square brackets. Should be
provided as “Sentence case” for direct use in the UI.

Example:Too Many Requests

Example

ApiKeyCredentialListItem

object

API key credential returned when listing credentials.

* Additional properties are NOT allowed.
typestringrequiredread-only

Allowed values:api_key

idstring(uuid)requiredread-only

Contains a unique identifier used for this resource.

Example:5f9fd312-a987-4628-b4c5-bb4f4fddd5f7

display_namestringrequired
statusstringread-only

Allowed values:activeexpiredrevoked

expires_atstring(date-time)read-only
created_atstring(date-time)requiredread-only

An ISO-8601 timestamp representation of entity creation date.

Example:2022-11-04T20:10:06.927Z

Example

ClientSecretCredentialListItem

object

Client secret credential returned when listing credentials.

* Additional properties are NOT allowed.
typestringrequiredread-only

Allowed values:client_secret

idstringrequired

Credential identifier

display_namestring

May not be available for all Client Credentials applications

client_idstringrequiredread-only

OAuth2 client identifier

created_atstring(date-time)requiredread-only

Creation timestamp, if available

expires_atstring(date-time)read-only

Expiration timestamp, if applicable

Example

CredentialListItem

object
One Of
typestringrequiredread-only

Allowed values:api_key

idstring(uuid)requiredread-only

Contains a unique identifier used for this resource.

Example:5f9fd312-a987-4628-b4c5-bb4f4fddd5f7

display_namestringrequired
statusstringread-only

Allowed values:activeexpiredrevoked

expires_atstring(date-time)read-only
created_atstring(date-time)requiredread-only

An ISO-8601 timestamp representation of entity creation date.

Example:2022-11-04T20:10:06.927Z

Example