Get Konnect Audit Log Webhook
Returns configuration for the audit log webhook.
Response
application/json
Response
Get response for audit logs webhook
UUID of an existing audit log destination.
Indicates whether audit data should be sent to the webhook.
Indicates whether the principal name is included in the audit logs sent to the webhook.
Authentication
Update Konnect Audit Log Webhook
Updates the configuration for a webhook to receive audit logs.
Body
application/json
Body
The request schema to modify an audit log webhook.
UUID of an existing audit log destination
Indicates if the data should be sent to the webhook.
Default:false
Indicates if the principal name should be included in the audit logs sent to the webhook.
Default:false
Response
application/json
Response
Get response for audit logs webhook
UUID of an existing audit log destination.
Indicates whether audit data should be sent to the webhook.
Indicates whether the principal name is included in the audit logs sent to the webhook.
Authentication
Body
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
The body of the last response received from the webhook endpoint.
<= 2048 characters
Example:{"message":"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.
UnauthorizedError
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
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
The error type.
Example:https://httpstatuses.com/401
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:Invalid credentials