3.0.5OAS 3.0

The API for configuring Kong Konnect Audit Logs.

API Base URL
  • Server 1:https://us.api.konghq.com/v3

    United-States Production region

  • Server 2:https://eu.api.konghq.com/v3

    Europe Production region

  • Server 3:https://au.api.konghq.com/v3

    Australia Production region

  • Server 4:https://me.api.konghq.com/v3

    Middle-East Production region

  • Server 5:https://in.api.konghq.com/v3

    India Production region

  • Server 6:https://sg.api.konghq.com/v3

    Singapore Production region

Security
personalAccessToken (http)

The personal access token is meant to be used as an alternative to basic-auth when accessing Konnect via APIs.
You can generate a Personal Access Token (PAT) from the personal access token page in the Konnect dashboard.
The PAT token must be passed in the header of a request, for example:
curl -X GET 'https://global.api.konghq.com/v2/users/' --header 'Authorization: Bearer kpat_xgfT...'

systemAccountAccessToken (http)

The system account access token is meant for automations and integrations that are not directly associated with a human identity.
You can generate a system account Access Token by creating a system account and then obtaining a system account access token for that account.
The access token must be passed in the header of a request, for example:
curl -X GET 'https://global.api.konghq.com/v2/users/' --header 'Authorization: Bearer spat_i2Ej...'

Additional Information
Contact Kong

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