Audit Logs

Update Audit Log Webhook

Changed on

Updates the configuration for a webhook to receive audit logs.

patch/v2/audit-log-webhook

Request

  • Base URL: https://global.api.konghq.com
  • URL: https://global.api.konghq.com/v2/audit-log-webhook
  • Auth: one of:
    • HTTP bearer
    • HTTP bearer
    • HTTP bearer
    • HTTP bearer

Request body

endpointstring nullable

The endpoint that will receive audit log messages.

authorizationstring nullable

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

enabledboolean

Indicates if the data should be sent to the webhook.

log_format'cef' | 'json' | 'cps'

The output format of each log messages.

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.

Example request

{
  "endpoint": "https://example.com/audit-logs",
  "authorization": "Bearer sometoken",
  "enabled": true
}

Response

Get response for audit log webhook

endpointstring nullable

The endpoint that will receive audit log messages.

enabledboolean nullable

Indicates whether audit data should be sent to the webhook.

log_format'cef' | 'json' | 'cps'

The output format of each log messages.

skip_ssl_verificationboolean

Indicates if the SSL certificate verification of the host endpoint should be skipped when delivering payloads.

updated_atstring date-time

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

Example response

{
  "endpoint": "https://example.com/audit-logs",
  "enabled": true
}

Changes

  • f530bf400198Revision changes
    • warning

      added the new 400.00 enum value to the response property for the response status

    • warning

      added the new 403.00 enum value to the response property for the response status

  • 4a02153f2e60Revision changes
    • breaking

      the response's body type changed from no type to object for status

    • breaking

      the response's body type changed from no type to object for status

    • info

      removed subschema #2 from the response body allOf list for the response status

    • info

      removed subschema #2 from the response body allOf list for the response status

    • info

      removed subschema #2 from the response body allOf list for the response status

    • info

      added the optional property to the response with the status

    • info

      added the optional property to the response with the status

    • info

      the response property became required for the status

    • info

      the response property became required for the status

    • info

      the response property became required for the status

    • info

      the response property became required for the status

    • info

      added the required property to the response with the status

    • info

      added the required property to the response with the status

    • info

      added the required property to the response with the status

    • info

      added the required property to the response with the status

    • info

      added the required property to the response with the status

    • info

      added the required property to the response with the status

    • info

      added the required property to the response with the status

    • info

      added the required property to the response with the status

    • info

      added the required property to the response with the status