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

Create Authentication failure logs

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

post

Body

application/json

The request schema to create authentication failure audit logs.

logsarray[object]

Auth Failure Log Stream Schema

Show Child Parameters

Response

No Content

post/internal/logstreams

Body

{ "logs": [ { "data": { "user_id": "auth0|1234", "date": "2024-09-03T04:23:06.115Z", "ip": "127.0.0.1", "type": "fp", "user_agent": "Mozilla/5.0 (Macintosh; Intel Mac OS X 10_15_7) AppleWebKit/537.36 (KHTML, like Gecko) Chrome/128.0.0.0 Safari/537.36" } } ] }
 

StreamLog

object

Auth Failure Log Stream Schema

dataobject

Log data

Show Child Parameters
Example

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