---
title: "Create Audit Log Destination"
url: "https://nov18-dev.movespot.fyi/apis/konnect-audit-log-settings-2/versions/16965b5b-ae38-4dcf-af0d-57ef0237d5e7/operations/create-audit-log-destination"
---

> Full API specification: https://nov18-dev.movespot.fyi/apis/konnect-audit-log-settings-2/versions/16965b5b-ae38-4dcf-af0d-57ef0237d5e7.md

# Create Audit Log Destination

`POST` `/audit-log-destinations`

Operation ID: `create-audit-log-destination`

Creates a configuration for the audit log destination.

## Request body

Content types: `application/json`

## Responses

- `201` - Audit log destination response
- `400` - Bad Request
- `401` - Unauthorized
- `403` - Forbidden

## OpenAPI definition

```yaml
openapi: 3.0.2
info:
  title: Konnect Audit Log Settings
  version: 2.0.0
servers:
  - url: https://us.api.konghq.com/v2
    description: United-States Production region
  - url: https://eu.api.konghq.com/v2
    description: Europe Production region
  - url: https://au.api.konghq.com/v2
    description: Australia Production region
  - url: https://me.api.konghq.com/v2
    description: Middle-East Production region
  - url: https://in.api.konghq.com/v2
    description: India Production region
  - url: https://sg.api.konghq.com/v2
    description: Singapore Production region
paths:
  /audit-log-destinations:
    post:
      operationId: create-audit-log-destination
      summary: Create Audit Log Destination
      description: Creates a configuration for the audit log destination.
      requestBody:
        $ref: "#/components/requestBodies/CreateAuditLogDestination"
      responses:
        "201":
          $ref: "#/components/responses/AuditLogDestinationSingle"
        "400":
          $ref: "#/components/responses/AuditLogDestinationBadRequest"
        "401":
          $ref: "#/components/responses/Unauthorized"
        "403":
          $ref: "#/components/responses/Forbidden"
      tags:
        - Audit Logs
security:
  - personalAccessToken: []
  - systemAccountAccessToken: []
components:
  requestBodies:
    CreateAuditLogDestination:
      description: The request schema to create an audit log destination.
      content:
        application/json:
          schema:
            type: object
            properties:
              name:
                description: The name of the audit log destination.
                type: string
                example: My Destination
              endpoint:
                description: The endpoint that will receive audit log messages.
                type: string
                example: https://example.com/audit-logs
              authorization:
                description: The value to include in the `Authorization` header when sending
                  audit logs to the webhook.
                type: string
                example: Bearer sometoken
                writeOnly: true
              log_format:
                $ref: "#/components/schemas/LogFormat"
              skip_ssl_verification:
                description: >-
                  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.
                type: boolean
                example: false
                default: false
            required:
              - name
              - endpoint
              - log_format
              - authorization
          examples:
            Create Audit Log Destination:
              $ref: "#/components/examples/Create-Audit-Log-Destination"
  responses:
    AuditLogDestinationSingle:
      description: Audit log destination response
      content:
        application/json:
          schema:
            $ref: "#/components/schemas/AuditLogDestination"
          examples:
            Audit Log Destination:
              $ref: "#/components/examples/Audit-Log-Destination"
    AuditLogDestinationBadRequest:
      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"
            Endpoint Cannot be Blank:
              $ref: "#/components/examples/400-endpoint-cannot-be-blank"
            Endpoint Must be a valid URL:
              $ref: "#/components/examples/400-endpoint-must-be-valid-url"
    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"
  schemas:
    LogFormat:
      description: The output format of each log messages.
      type: string
      default: cef
      enum:
        - cef
        - json
        - cps
    AuditLogDestination:
      description: Audit Log Destination Schema
      type: object
      properties:
        id:
          description: The unique ID of the audit log destination.
          type: string
          format: uuid
        name:
          description: The name of the audit log destination.
          type: string
        endpoint:
          description: The endpoint that will receive audit log messages.
          type: string
          example: https://example.com/audit-logs
        log_format:
          $ref: "#/components/schemas/LogFormat"
        skip_ssl_verification:
          description: Indicates if the SSL certificate verification of the host endpoint
            should be skipped when delivering payloads.
          type: boolean
          example: false
          default: false
        created_at:
          description: Timestamp when this webhook was created.
          type: string
          format: date-time
          readOnly: true
        updated_at:
          description: Timestamp when this webhook was last updated. Initial value is
            0001-01-01T00:00:0Z.
          type: string
          format: date-time
          readOnly: true
      title: AuditLogDestination
    BadRequestError:
      allOf:
        - $ref: "#/components/schemas/BaseError"
        - type: object
          required:
            - invalid_parameters
          properties:
            invalid_parameters:
              $ref: "#/components/schemas/InvalidParameters"
    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
    BaseError:
      description: standard error
      type: object
      properties:
        status:
          description: >
            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.
          type: integer
          readOnly: true
        title:
          description: |
            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.
          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
            kong:trace:<correlation_id>. This helps us find the relevant logs
            when a customer reports an issue.
          type: string
          readOnly: true
        detail:
          description: >
            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.
          type: string
          readOnly: true
      required:
        - status
        - title
        - instance
        - detail
      title: Error
    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
    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
    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
  examples:
    Create-Audit-Log-Destination:
      value:
        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
    Audit-Log-Destination:
      value:
        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
    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-endpoint-cannot-be-blank:
      value:
        status: 400
        title: Bad Request
        detail: Required field missing
        instance: konnect:trace:6644808935508571943
        invalid_parameters:
          - field: endpoint
            reason: cannot be blank
    400-endpoint-must-be-valid-url:
      value:
        status: 400
        title: Bad Request
        detail: Invalid endpoint
        instance: konnect:trace:6644808935508571943
        invalid_parameters:
          - field: endpoint
            reason: must be a valid URL
    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
  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.

        You can generate a Personal Access Token (PAT) from the [personal access
        token page](https://cloud.konghq.com/global/account/tokens/) 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:
      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.

        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...'`
```
