API docs by Redocly

Konnect Audit Log Settings (2.0.0)

Download OpenAPI specification:Download

URL: https://konghq.com

The API for configuring Kong Konnect Audit Logs.

Audit Logs

Update Audit Log Replay Job

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

Authorizations:
personalAccessTokensystemAccountAccessToken
Request Body schema: application/json

The request schema to replace an audit log replay job.

start_at
required
string <date-time>

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_at
required
string <date-time>

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

Responses

Request samples

Content type
application/json
{
  • "start_at": "2019-08-24T14:15:22Z",
  • "end_at": "2019-08-24T14:15:22Z"
}

Response samples

Content type
application/json
{
  • "start_at": "2017-07-21T17:32:28Z",
  • "end_at": "2017-07-21T17:32:28Z",
  • "status": "unconfigured",
  • "updated_at": "2019-08-24T14:15:22Z"
}

Get Audit Log Replay Job

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

Authorizations:
personalAccessTokensystemAccountAccessToken

Responses

Response samples

Content type
application/json
{
  • "start_at": "2017-07-21T17:32:28Z",
  • "end_at": "2017-07-21T17:32:28Z",
  • "status": "unconfigured",
  • "updated_at": "2019-08-24T14:15:22Z"
}

Update Audit Log Webhook

Updates the configuration for a webhook to receive audit logs.

Authorizations:
personalAccessTokensystemAccountAccessToken
Request Body schema: application/json

The request schema to modify an audit log webhook.

endpoint
string

The endpoint that will receive audit log messages.

authorization
string

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

enabled
boolean
Default: false

Indicates if the data should be sent to the webhook.

log_format
string
Default: "cef"
Enum: "cef" "json"

The output format of each log message.

skip_ssl_verification
boolean
Default: false

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.

Responses

Request samples

Content type
application/json
Example
{
  • "enabled": false
}

Response samples

Content type
application/json
{
  • "endpoint": "https://example.com/audit-log",
  • "enabled": true,
  • "log_format": "cef",
  • "skip_ssl_verification": false,
  • "updated_at": "2023-03-21T09:29:14.52Z"
}

Get Audit Log Webhook

Returns configuration for the audit log webhook.

Authorizations:
personalAccessTokensystemAccountAccessToken

Responses

Response samples

Content type
application/json
{
  • "endpoint": "https://example.com/audit-log",
  • "enabled": true,
  • "log_format": "cef",
  • "skip_ssl_verification": false,
  • "updated_at": "2023-03-21T09:29:14.52Z"
}

Get Audit Log Webhook Status

Returns status of the audit log webhook.

Authorizations:
personalAccessTokensystemAccountAccessToken

Responses

Response samples

Content type
application/json
{
  • "webhook_enabled": true,
  • "webhook_status": "inactive",
  • "last_attempt_at": "2023-03-21T09:29:14.52Z",
  • "last_response_code": 401,
  • "last_response_message": "Unauthorized"
}

Get Audit Log JSON Web Keys

Returns the public keys used to sign audit log entries in order to verify the validity of audit log entries.

Authorizations:
personalAccessTokensystemAccountAccessToken

Responses

Response samples

Content type
application/json
{
  • "keys": [
    ]
}

Get Audit Log Destinations

Returns configuration for the audit log destinations.

Authorizations:
personalAccessTokensystemAccountAccessToken
query Parameters
page[size]
integer
Example: page[size]=10

The maximum number of items to include per page. The last page of a collection may include fewer items.

page[after]
string
Example: page[after]=ewogICJpZCI6ICJoZWxsbyB3b3JsZCIKfQ

Request the next page of data, starting with the item after this parameter.

page[before]
string
Example: page[before]=ewogICJpZCI6ICJoZWxsbyB3b3JsZCIKfQ

Request the next page of data, starting with the item before this parameter.

object

Filter destinations returned in the response.

Responses

Response samples

Content type
application/json
{
  • "data": [
    ],
  • "meta": {
    }
}

Create Audit Log Destination

Creates a configuration for the audit log destination.

Authorizations:
personalAccessTokensystemAccountAccessToken
Request Body schema: application/json

The request schema to create an audit log destination.

name
required
string

The name of the audit log destination.

endpoint
required
string

The endpoint that will receive audit log messages.

authorization
string

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

log_format
required
string
Default: "cef"
Enum: "cef" "json"

The output format of each log message.

skip_ssl_verification
boolean
Default: false

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.

Responses

Request samples

Content type
application/json
{
  • "id": "07ec3858-066b-4629-bdc5-d4aa893b424d",
  • "name": "My Destination",
  • "endpoint": "https://example.com/audit-log",
  • "authorization": "Bearer token",
  • "log_format": "cef",
  • "skip_ssl_verification": false
}

Response samples

Content type
application/json
{
  • "id": "07ec3858-066b-4629-bdc5-d4aa893b424d",
  • "name": "My Destination",
  • "endpoint": "https://example.com/audit-log",
  • "log_format": "cef",
  • "skip_ssl_verification": false,
  • "created_at": "2023-03-20T09:29:14.52Z",
  • "updated_at": "2023-03-21T09:29:14.52Z"
}

Get Audit Log Destination

Returns configuration for the audit log destination.

Authorizations:
personalAccessTokensystemAccountAccessToken
path Parameters
auditLogDestinationId
required
string <uuid>

ID of the Audit Log Destination.

Responses

Response samples

Content type
application/json
{
  • "id": "07ec3858-066b-4629-bdc5-d4aa893b424d",
  • "name": "My Destination",
  • "endpoint": "https://example.com/audit-log",
  • "log_format": "cef",
  • "skip_ssl_verification": false,
  • "created_at": "2023-03-20T09:29:14.52Z",
  • "updated_at": "2023-03-21T09:29:14.52Z"
}

Update Audit Log Destination

Updates configuration for the audit log destination.

Authorizations:
personalAccessTokensystemAccountAccessToken
path Parameters
auditLogDestinationId
required
string <uuid>

ID of the Audit Log Destination.

Request Body schema: application/json

The request schema to modify an audit log destination.

name
string

The name of the audit log destination.

endpoint
string

The endpoint that will receive audit log messages.

authorization
string

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

log_format
string
Default: "cef"
Enum: "cef" "json"

The output format of each log message.

skip_ssl_verification
boolean
Default: false

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.

Responses

Request samples

Content type
application/json
{}

Response samples

Content type
application/json
{
  • "id": "07ec3858-066b-4629-bdc5-d4aa893b424d",
  • "name": "My Destination",
  • "endpoint": "https://example.com/audit-log",
  • "log_format": "cef",
  • "skip_ssl_verification": false,
  • "created_at": "2023-03-20T09:29:14.52Z",
  • "updated_at": "2023-03-21T09:29:14.52Z"
}

Delete Audit Log Destination

Deletes configuration for the audit log destination.

Authorizations:
personalAccessTokensystemAccountAccessToken
path Parameters
auditLogDestinationId
required
string <uuid>

ID of the Audit Log Destination.

Responses

Response samples

Content type
application/problem+json
{
  • "status": 401,
  • "title": "Unauthorized",
  • "instance": "kong:trace:8347343766220159418",
  • "detail": "Unauthorized"
}

Create Authentication failure logs

This webhook endpoint Creates login failure audit logs using log stream sent by external vendor services (Currently Auth0).

Authorizations:
personalAccessTokensystemAccountAccessToken
Request Body schema: application/json

The request schema to create authentication failure audit logs.

Array of objects (StreamLog)

Responses

Request samples

Content type
application/json
{
  • "logs": [
    ]
}

Response samples

Content type
application/problem+json
{
  • "status": 403,
  • "title": "Forbidden",
  • "instance": "kong:trace:2723154947768991354",
  • "detail": "You do not have permission to perform this action"
}