2.0.0OAS 3.0

The API for configuring Kong Konnect Audit Logs.

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

    United-States Production region

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

    Europe Production region

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

    Australia Production region

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

    Middle-East Production region

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

    India Production region

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

    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

Update Audit Log Replay Job

Updates a job to re-send audit logs to an organization’s webhook.

put

Body

application/json

The request schema to replace an audit log replay job.

start_atstring(date-time)required

The start of a date-time range in RFC3339 format e.g. 2017-07-21T17:32:28Z.
Must be within the last 7 days.

end_atstring(date-time)required

The end of a date-time range in RFC3339 format e.g. 2017-07-21T17:32:28Z.
Must be within the last 7 days.

Response

application/json

Response from fetching or updating an audit log replay job

start_atstring(date-time)

The start of a date-time range. Initial value is 0001-01-01T00:00:0Z.

Example:2017-07-21T17:32:28Z

end_atstring(date-time)

The end of a date-time range. Initial value is 0001-01-01T00:00:0Z.

Example:2017-07-21T17:32:28Z

statusstringread-only

Allowed values:unconfiguredacceptedpendingrunningcompletedfailed

updated_atstring(date-time)read-only

Timestamp when this job was last updated. Initial value is 0001-01-01T00:00:0Z.

put/audit-log-replay-job

Body

{ "start_at": "start_at", "end_at": "end_at" }
 
application/json

Get Audit Log Replay Job

Returns the audit log replay job’s configuration and status.

get

Response

application/json

Response from fetching or updating an audit log replay job

start_atstring(date-time)

The start of a date-time range. Initial value is 0001-01-01T00:00:0Z.

Example:2017-07-21T17:32:28Z

end_atstring(date-time)

The end of a date-time range. Initial value is 0001-01-01T00:00:0Z.

Example:2017-07-21T17:32:28Z

statusstringread-only

Allowed values:unconfiguredacceptedpendingrunningcompletedfailed

updated_atstring(date-time)read-only

Timestamp when this job was last updated. Initial value is 0001-01-01T00:00:0Z.

get/audit-log-replay-job
 
application/json

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

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

enabledboolean

Indicates if the data should be sent to the webhook.

Default:false

Example:true

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

Get response for audit log webhook

endpointstring

The endpoint that will receive audit log messages.

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

enabledboolean

Indicates whether audit data should be sent to the webhook.

Example:true

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

updated_atstring(date-time)read-only

Timestamp when this webhook was last updated. Initial value is 0001-01-01T00:00:0Z.

patch/audit-log-webhook

Body

{ "enabled": false }
 
application/json