BadRequestError

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.

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.

typestringread-only

The error type.

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.

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.

invalid_parametersOne Of
arrayrequiredunique-items

invalid parameters

>= 1 items

InvalidParameterStandardobject
* Additional properties are NOT allowed.
Show Child Parameters
Example

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

LegacyStringFieldFilter

object

Filter using one of the following operators: eq, contains

* Additional properties are NOT allowed.
eqstring

The field exactly matches the provided value.

Example:?filter[field_name_here][eq]=foo

containsstring

The field contains the provided value.

Example:?filter[field_name_here][contains]=foo

Example

LogFormat

string

The output format of each log messages.

Allowed values:cefjsoncps

Default:cef

AuditLogDestination

object

Audit Log Destination Schema

idstring(uuid)

The unique ID of the audit log destination.

namestring

The name of the audit log destination.

endpointstring

The endpoint that will receive audit log messages.

Example:https://example.com/audit-logs

log_formatstring

The output format of each log messages.

Allowed values:cefjsoncps

Default:cef

skip_ssl_verificationboolean

Indicates if the SSL certificate verification of the host endpoint should be skipped when delivering payloads.

Default:false

created_atstring(date-time)read-only

Timestamp when this webhook was created.

updated_atstring(date-time)read-only

Timestamp when this webhook was last updated. Initial value is 0001-01-01T00:00:0Z.

Example