BadRequestError
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.
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.
The error type.
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.
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.
One Ofinvalid parameters
>= 1 items
Show Child Parameters
ConflictError
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
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
The error type.
Example:https://httpstatuses.com/409
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
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
LegacyStringFieldFilter
objectFilter using one of the following operators: eq, contains
The field exactly matches the provided value.
Example:?filter[field_name_here][eq]=foo
The field contains the provided value.
Example:?filter[field_name_here][contains]=foo
LogFormat
stringThe output format of each log messages.
Allowed values:cefjsoncps
Default:cef
AuditLogDestination
objectAudit Log Destination Schema
The unique ID of the audit log destination.
The name of the audit log destination.
The endpoint that will receive audit log messages.
Example:https://example.com/audit-logs
The output format of each log messages.
Allowed values:cefjsoncps
Default:cef
Indicates if the SSL certificate verification of the host endpoint should be skipped when delivering payloads.
Default:false
Timestamp when this webhook was created.
Timestamp when this webhook was last updated. Initial value is 0001-01-01T00:00:0Z.