Audit Logs

Get Konnect Audit Log Webhook

Returns configuration for the audit log webhook.

get

Response

application/json

Get response for audit logs webhook

audit_log_destination_idstring(uuid)required

UUID of an existing audit log destination.

enabledbooleanrequired

Indicates whether audit data should be sent to the webhook.

include_principal_nameboolean

Indicates whether the principal name is included in the audit logs sent to the webhook.

get/audit-log-webhook
 
application/json

Update Konnect Audit Log Webhook

Updates the configuration for a webhook to receive audit logs.

patch

Body

application/json

The request schema to modify an audit log webhook.

audit_log_destination_idstring(uuid)

UUID of an existing audit log destination

enabledboolean

Indicates if the data should be sent to the webhook.

Default:false

include_principal_nameboolean

Indicates if the principal name should be included in the audit logs sent to the webhook.

Default:false

Response

application/json

Get response for audit logs webhook

audit_log_destination_idstring(uuid)required

UUID of an existing audit log destination.

enabledbooleanrequired

Indicates whether audit data should be sent to the webhook.

include_principal_nameboolean

Indicates whether the principal name is included in the audit logs sent to the webhook.

patch/audit-log-webhook

Body

{ "audit_log_destination_id": "6945c4c4-3e06-4c5c-87e0-726d0cda4e05", "include_principal_name": true }
 
application/json

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

last_response_bodystring

The body of the last response received from the webhook endpoint.

<= 2048 characters

Example:{"message":"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