---
title: "Konnect Audit Log Settings"
url: "https://nov18-dev.movespot.fyi/apis/konnect-audit-log-settings-internal-2/versions/71c88c5e-4e14-4c33-a94c-78e6ae10d377"
---

# Konnect Audit Log Settings

OpenAPI specification document.

```json
{"openapi":"3.0.2","info":{"title":"Konnect Audit Log Settings","version":"3.0.5","description":"The API for configuring Kong Konnect Audit Logs.","contact":{"name":"Kong","url":"https://konghq.com"}},"servers":[{"url":"https://us.api.konghq.com/v3","description":"United-States Production region"},{"url":"https://eu.api.konghq.com/v3","description":"Europe Production region"},{"url":"https://au.api.konghq.com/v3","description":"Australia Production region"},{"url":"https://me.api.konghq.com/v3","description":"Middle-East Production region"},{"url":"https://in.api.konghq.com/v3","description":"India Production region"},{"url":"https://sg.api.konghq.com/v3","description":"Singapore Production region"}],"paths":{"/audit-log-webhook":{"get":{"operationId":"get-audit-logs-webhook","summary":"Get Konnect Audit Log Webhook","description":"Returns configuration for the audit log webhook.","responses":{"200":{"$ref":"#/components/responses/AuditLogsWebhook"},"401":{"$ref":"#/components/responses/Unauthorized"},"403":{"$ref":"#/components/responses/Forbidden"},"404":{"$ref":"#/components/responses/NotFound"}},"tags":["Audit Logs"]},"patch":{"operationId":"update-audit-logs-webhook","summary":"Update Konnect Audit Log Webhook","description":"Updates the configuration for a webhook to receive audit logs.","requestBody":{"$ref":"#/components/requestBodies/UpdateAuditLogsWebhook"},"responses":{"200":{"$ref":"#/components/responses/AuditLogsWebhook"},"400":{"$ref":"#/components/responses/AuditLogsWebhookBadRequest"},"401":{"$ref":"#/components/responses/Unauthorized"},"403":{"$ref":"#/components/responses/Forbidden"},"404":{"$ref":"#/components/responses/NotFound"}},"tags":["Audit Logs"]}},"/audit-log-webhook/status":{"get":{"operationId":"get-audit-logs-webhook-status","summary":"Get Audit Log Webhook Status","description":"Returns status of the audit log webhook.","responses":{"200":{"$ref":"#/components/responses/AuditLogsWebhookStatus"},"401":{"$ref":"#/components/responses/Unauthorized"},"403":{"$ref":"#/components/responses/Forbidden"}},"tags":["Audit Logs"]}}},"components":{"schemas":{"BaseError":{"description":"standard error","type":"object","properties":{"status":{"description":"The HTTP status code of the error. Useful when passing the response\nbody to child properties in a frontend UI. Must be returned as an integer.\n","type":"integer","readOnly":true},"title":{"description":"A short, human-readable summary of the problem. It should not\nchange between occurences of a problem, except for localization.\nShould be provided as \"Sentence case\" for direct use in the UI.\n","type":"string","readOnly":true},"type":{"description":"The error type.","type":"string","readOnly":true},"instance":{"description":"Used to return the correlation ID back to the user, in the format\nkong:trace:<correlation_id>. This helps us find the relevant logs\nwhen a customer reports an issue.\n","type":"string","readOnly":true},"detail":{"description":"A human readable explanation specific to this occurence of the problem.\nThis field may contain request/entity data to help the user understand\nwhat went wrong. Enclose variable values in square brackets. Should be\nprovided as \"Sentence case\" for direct use in the UI.\n","type":"string","readOnly":true}},"required":["status","title","instance","detail"],"title":"Error"},"UnauthorizedError":{"allOf":[{"$ref":"#/components/schemas/BaseError"},{"type":"object","properties":{"status":{"example":401},"title":{"example":"Unauthorized"},"type":{"example":"https://httpstatuses.com/401"},"instance":{"example":"kong:trace:1234567890"},"detail":{"example":"Invalid credentials"}}}]},"ForbiddenError":{"allOf":[{"$ref":"#/components/schemas/BaseError"},{"type":"object","properties":{"status":{"example":403},"title":{"example":"Forbidden"},"type":{"example":"https://httpstatuses.com/403"},"instance":{"example":"kong:trace:1234567890"},"detail":{"example":"Forbidden"}}}]},"NotFoundError":{"allOf":[{"$ref":"#/components/schemas/BaseError"},{"type":"object","properties":{"status":{"example":404},"title":{"example":"Not Found"},"type":{"example":"https://httpstatuses.com/404"},"instance":{"example":"kong:trace:1234567890"},"detail":{"example":"Not found"}}}]},"InvalidRules":{"description":"invalid parameters rules","type":"string","enum":["required","is_array","is_base64","is_boolean","is_date_time","is_integer","is_null","is_number","is_object","is_string","is_uuid","is_fqdn","is_arn","unknown_property","missing_reference","is_label","matches_regex","invalid","is_supported_network_availability_zone_list","is_supported_network_cidr_block","is_supported_provider_region","type"],"nullable":true,"readOnly":true},"InvalidParameterStandard":{"type":"object","properties":{"field":{"type":"string","example":"name","readOnly":true},"rule":{"$ref":"#/components/schemas/InvalidRules"},"source":{"type":"string","example":"body"},"reason":{"type":"string","example":"is a required field","readOnly":true}},"additionalProperties":false,"required":["field","reason"]},"InvalidParameterMinimumLength":{"type":"object","properties":{"field":{"type":"string","example":"name","readOnly":true},"rule":{"description":"invalid parameters rules","type":"string","enum":["min_length","min_digits","min_lowercase","min_uppercase","min_symbols","min_items","min"],"nullable":false,"readOnly":true},"minimum":{"type":"integer","example":8},"source":{"type":"string","example":"body"},"reason":{"type":"string","example":"must have at least 8 characters","readOnly":true}},"additionalProperties":false,"required":["field","reason","rule","minimum"]},"InvalidParameterMaximumLength":{"type":"object","properties":{"field":{"type":"string","example":"name","readOnly":true},"rule":{"description":"invalid parameters rules","type":"string","enum":["max_length","max_items","max"],"nullable":false,"readOnly":true},"maximum":{"type":"integer","example":8},"source":{"type":"string","example":"body"},"reason":{"type":"string","example":"must not have more than 8 characters","readOnly":true}},"additionalProperties":false,"required":["field","reason","rule","maximum"]},"InvalidParameterChoiceItem":{"type":"object","properties":{"field":{"type":"string","example":"name","readOnly":true},"rule":{"description":"invalid parameters rules","type":"string","enum":["enum"],"nullable":false,"readOnly":true},"reason":{"type":"string","example":"is a required field","readOnly":true},"choices":{"type":"array","items":{},"minItems":1,"nullable":false,"readOnly":true,"uniqueItems":true},"source":{"type":"string","example":"body"}},"additionalProperties":false,"required":["field","reason","rule","choices"]},"InvalidParameterDependentItem":{"type":"object","properties":{"field":{"type":"string","example":"name","readOnly":true},"rule":{"description":"invalid parameters rules","type":"string","enum":["dependent_fields"],"nullable":true,"readOnly":true},"reason":{"type":"string","example":"is a required field","readOnly":true},"dependents":{"type":"array","items":{},"nullable":true,"readOnly":true,"uniqueItems":true},"source":{"type":"string","example":"body"}},"additionalProperties":false,"required":["field","rule","reason","dependents"]},"InvalidParameters":{"description":"invalid parameters","type":"array","items":{"oneOf":[{"$ref":"#/components/schemas/InvalidParameterStandard"},{"$ref":"#/components/schemas/InvalidParameterMinimumLength"},{"$ref":"#/components/schemas/InvalidParameterMaximumLength"},{"$ref":"#/components/schemas/InvalidParameterChoiceItem"},{"$ref":"#/components/schemas/InvalidParameterDependentItem"}]},"minItems":1,"nullable":false,"uniqueItems":true},"BadRequestError":{"allOf":[{"$ref":"#/components/schemas/BaseError"},{"type":"object","required":["invalid_parameters"],"properties":{"invalid_parameters":{"$ref":"#/components/schemas/InvalidParameters"}}}]}},"examples":{"Get-Audit-Logs-Webhook":{"value":{"audit_log_destination_id":"6945c4c4-3e06-4c5c-87e0-726d0cda4e05","enabled":true,"include_principal_name":false}},"Get-Audit-Logs-Webhook-Status":{"value":{"webhook_enabled":true,"webhook_status":"inactive","last_attempt_at":"2023-03-21T09:29:14.52Z","last_response_code":401,"last_response_message":"Unauthorized","last_response_body":"{\"message\":\"Unauthorized\"}"}},"400-request-format-is-invalid":{"value":{"status":400,"title":"Bad Request","detail":"Could not parse request body","instance":"konnect:trace:3674017986744198214","invalid_parameters":[{"field":"body","reason":"request format is invalid"}]}},"400-authorization-cannot-be-blank":{"value":{"status":400,"title":"Bad Request","detail":"Required field missing","instance":"konnect:trace:6644808935508571943","invalid_parameters":[{"field":"authorization","reason":"cannot be blank"}]}},"400-destination-id-format-is-invalid":{"value":{"status":400,"title":"Bad Request","detail":"Could not parse destination id","instance":"konnect:trace:3674017986744198214","invalid_parameters":[{"field":"audit_log_destination_id","reason":"destination id format is invalid"}]}},"Update-Audit-Logs-Webhook":{"value":{"audit_log_destination_id":"6945c4c4-3e06-4c5c-87e0-726d0cda4e05","include_principal_name":true}},"Disable-Audit-Logs-Webhook":{"value":{"enabled":false}},"Create-Audit-Logs-Webhook":{"value":{"audit_log_destination_id":"6945c4c4-3e06-4c5c-87e0-726d0cda4e05","enabled":true}},"UnauthorizedExample":{"value":{"status":401,"title":"Unauthorized","instance":"kong:trace:8347343766220159418","detail":"Unauthorized"}},"ForbiddenExample":{"value":{"status":403,"title":"Forbidden","instance":"kong:trace:2723154947768991354","detail":"You do not have permission to perform this action"}},"NotFoundExample":{"value":{"status":404,"title":"Not Found","instance":"kong:trace:6816496025408232265","detail":"Not Found"}}},"requestBodies":{"UpdateAuditLogsWebhook":{"description":"The request schema to modify an audit log webhook.","content":{"application/json":{"schema":{"type":"object","properties":{"audit_log_destination_id":{"description":"UUID of an existing audit log destination","type":"string","format":"uuid"},"enabled":{"description":"Indicates if the data should be sent to the webhook.","type":"boolean","default":false},"include_principal_name":{"description":"Indicates if the principal name should be included in the audit logs sent to the webhook.","type":"boolean","default":false}}},"examples":{"Update Audit Log Webhook":{"$ref":"#/components/examples/Update-Audit-Logs-Webhook"},"Disable Audit Log Webhook":{"$ref":"#/components/examples/Disable-Audit-Logs-Webhook"},"Create Audit Log Webhook":{"$ref":"#/components/examples/Create-Audit-Logs-Webhook"}}}}}},"responses":{"AuditLogsWebhook":{"description":"Get response for audit logs webhook","content":{"application/json":{"schema":{"type":"object","properties":{"audit_log_destination_id":{"description":"UUID of an existing audit log destination.","type":"string","format":"uuid"},"enabled":{"description":"Indicates whether audit data should be sent to the webhook.","type":"boolean"},"include_principal_name":{"description":"Indicates whether the principal name is included in the audit logs sent to the webhook.","type":"boolean"}},"required":["audit_log_destination_id","enabled"]},"examples":{"Get Audit Log Webhook":{"$ref":"#/components/examples/Get-Audit-Logs-Webhook"}}}}},"AuditLogsWebhookBadRequest":{"description":"Bad Request","content":{"application/problem+json":{"schema":{"$ref":"#/components/schemas/BadRequestError"},"examples":{"Request Format is Invalid":{"$ref":"#/components/examples/400-request-format-is-invalid"},"Authorization Cannot be Blank":{"$ref":"#/components/examples/400-authorization-cannot-be-blank"},"Destination ID format is invalid":{"$ref":"#/components/examples/400-destination-id-format-is-invalid"}}}}},"AuditLogsWebhookStatus":{"description":"Get response for audit logs webhook status","content":{"application/json":{"schema":{"type":"object","properties":{"webhook_status":{"description":"Current status of a webhook. `active` indicates the webhook is sending or ready to send requests.\n`inactive` indicates the webhook has been turned off due to failed attempts.","type":"string","example":"active","enum":["active","inactive"]},"webhook_enabled":{"description":"Configured status of a webhook. `enabled` indicates the client will accept requests.\n`disabled` indicates the client will not accept requests.","type":"boolean","example":true},"last_attempt_at":{"description":"The last time a request was made to the webhook, regardless of outcome.","type":"string","format":"date-time","example":"2023-03-21T09:29:14.52Z"},"last_response_code":{"description":"The last response code received from the webhook.","type":"integer","example":401},"last_response_message":{"description":"The last message received from the webhook. Useful for debugging.","type":"string","example":"Unauthenticated"},"last_response_body":{"description":"The body of the last response received from the webhook endpoint.","type":"string","example":"{\"message\":\"Unauthenticated\"}","maxLength":2048}}},"examples":{"Get Audit Log Webhook Status":{"$ref":"#/components/examples/Get-Audit-Logs-Webhook-Status"}}}}},"Unauthorized":{"description":"Unauthorized","content":{"application/problem+json":{"schema":{"$ref":"#/components/schemas/UnauthorizedError"},"examples":{"UnauthorizedExample":{"$ref":"#/components/examples/UnauthorizedExample"}}}}},"Forbidden":{"description":"Forbidden","content":{"application/problem+json":{"schema":{"$ref":"#/components/schemas/ForbiddenError"},"examples":{"UnauthorizedExample":{"$ref":"#/components/examples/ForbiddenExample"}}}}},"NotFound":{"description":"Not Found","content":{"application/problem+json":{"schema":{"$ref":"#/components/schemas/NotFoundError"},"examples":{"NotFoundExample":{"$ref":"#/components/examples/NotFoundExample"}}}}}},"securitySchemes":{"personalAccessToken":{"type":"http","scheme":"bearer","bearerFormat":"Token","description":"The personal access token is meant to be used as an alternative to basic-auth when accessing Konnect via APIs.\nYou can generate a Personal Access Token (PAT) from the [personal access token page](https://cloud.konghq.com/global/account/tokens/) in the Konnect dashboard.\nThe PAT token must be passed in the header of a request, for example:\n`curl -X GET 'https://global.api.konghq.com/v2/users/' --header 'Authorization: Bearer kpat_xgfT...'`\n"},"systemAccountAccessToken":{"type":"http","scheme":"bearer","bearerFormat":"Token","description":"The system account access token is meant for automations and integrations that are not directly associated with a human identity.\nYou can generate a system account Access Token by creating a system account and then obtaining a system account access token for that account.\nThe access token must be passed in the header of a request, for example:\n`curl -X GET 'https://global.api.konghq.com/v2/users/' --header 'Authorization: Bearer spat_i2Ej...'`\n"}}},"tags":[{"name":"Audit Logs"}],"security":[{"personalAccessToken":[]},{"systemAccountAccessToken":[]}]}
```
