Update Audit Log Destination

Updates configuration for the audit log destination.

patch

Path Parameters

auditLogDestinationIdstring(uuid)required

ID of the Audit Log Destination.

Body

application/json

The request schema to modify an audit log destination.

namestring

The name of the audit log destination.

Example:My Destination

endpointstring

The endpoint that will receive audit log messages.

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

authorizationstring

The value to include in the Authorization header when sending audit logs to the webhook.

Example:Bearer sometoken

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.
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

Audit log destination response

AuditLogDestination

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

Example: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.

patch/audit-log-destinations/{auditLogDestinationId}

Body

{ "endpoint": "https://example.com/audit-log-json", "log_format": "json", "skip_ssl_verification": false }
 
application/json

Delete Audit Log Destination

Deletes configuration for the audit log destination.

delete

Path Parameters

auditLogDestinationIdstring(uuid)required

ID of the Audit Log Destination.

Response

No Content

delete/audit-log-destinations/{auditLogDestinationId}
 

Get Audit Log Webhook Status

Returns status of the audit log webhook.

get

Response

application/json

Get response for audit logs webhook status

webhook_statusstring

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

webhook_enabledboolean

Configured status of a webhook. enabled indicates the client will accept requests.
disabled indicates the client will not accept requests.

Example:true

last_attempt_atstring(date-time)

The last time a request was made to the webhook, regardless of outcome.

Example:2023-03-21T09:29:14.52Z

last_response_codeinteger

The last response code received from the webhook.

Example:401

last_response_messagestring

The last message received from the webhook. Useful for debugging.

Example:Unauthenticated

get/audit-log-webhook/status
 
application/json

Error

object

standard error

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.

Example

UnauthorizedError

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:401

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:Unauthorized

typestringread-only

The error type.

Example:https://httpstatuses.com/401

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:Invalid credentials

Example