3.4.1OAS 3.0

The management API for Portals

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

Get Portal Audit Log Webhook Status

Returns status of the audit log webhook.

get

Path Parameters

portalIdstring(uuid)required

ID of the portal.

Response

application/json

Get response for portal audit log 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/portals/{portalId}/audit-log-webhook/status
 
application/json

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