Get Audit Log Destination
Returns configuration for the audit log destination.
Path Parameters
ID of the Audit Log Destination.
Response
application/json
Response
Audit log destination response
AuditLogDestination
Audit 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
Example:false
Timestamp when this webhook was created.
Timestamp when this webhook was last updated. Initial value is 0001-01-01T00:00:0Z.
Authentication
Path Parameters
Update Audit Log Destination
Updates configuration for the audit log destination.
Path Parameters
ID of the Audit Log Destination.
Body
application/json
Body
The request schema to modify an audit log destination.
The name of the audit log destination.
Example:My Destination
The endpoint that will receive audit log messages.
Example:https://example.com/audit-logs
The value to include in the Authorization header when sending audit logs to the webhook.
Example:Bearer sometoken
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.
We strongly recommend not setting this to ‘true’ as you are subject to man-in-the-middle and other attacks.
This option should be considered only for self-signed SSL certificates used in a non-production environment.
Default:false
Example:false
Response
application/json
Response
Audit log destination response
AuditLogDestination
Audit 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
Example:false
Timestamp when this webhook was created.
Timestamp when this webhook was last updated. Initial value is 0001-01-01T00:00:0Z.
Authentication
Path Parameters
Body
Delete Audit Log Destination
Deletes configuration for the audit log destination.
Path Parameters
ID of the Audit Log Destination.
Response
Response
No Content
Authentication
Path Parameters
Get Audit Log Webhook Status
Returns status of the audit log webhook.
Response
application/json
Response
Get response for audit logs webhook status
Current status of a webhook. active indicates the webhook is sending or ready to send requests.
inactive indicates the webhook has been turned off due to failed attempts.
Allowed values:activeinactive
Example:active
Configured status of a webhook. enabled indicates the client will accept requests.
disabled indicates the client will not accept requests.
Example:true
The last time a request was made to the webhook, regardless of outcome.
Example:2023-03-21T09:29:14.52Z
The last response code received from the webhook.
Example:401
The last message received from the webhook. Useful for debugging.
Example:Unauthenticated
Authentication
Error
objectstandard error
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.