Akamai API Security HTTP header logs API

openapi: 3.2.0
info:
  description: 'Manage your configurations for Kona Site Defender,

    Web Application Protector, and Client Reputation.

    '
  license:
    name: Apache 2.0
    url: https://www.apache.org/licenses/LICENSE-2.0.html
  title: 'Akamai: Application Security Activation history HTTP header logs API'
  version: v1
servers:
- url: https://{hostname}/appsec/v1
tags:
- description: Manage the HTTP header log settings for security policies.
  name: HTTP header logs
paths:
  /configs/{configId}/versions/{versionNumber}/advanced-settings/logging:
    parameters:
    - description: A unique identifier for each configuration.
      example: '{{configId}}'
      in: path
      name: configId
      required: true
      schema:
        example: 77653
        format: int64
        type: integer
      x-akamai:
        file-path: parameters/config-id-path.yaml
    - description: A unique identifier for each version of a configuration.
      example: '{{versionNumber}}'
      in: path
      name: versionNumber
      required: true
      schema:
        example: 25
        type: integer
      x-akamai:
        file-path: parameters/version-number-path.yaml
    x-akamai:
      file-path: paths/config-logging.yaml
      path-info: /configs/{configId}/versions/{versionNumber}/advanced-settings/logging
    get:
      description: Lists HTTP header logging controls for a configuration. HTTP header logging is on by default, and in most cases you should leave it enabled. You can filter requests by header type, including or excluding requests with a specific header, or by cookie. This operation applies at the configuration level, and therefore applies to all policies within a configuration. If you want to view these settings for a specific policy, run [Get HTTP header log settings](https://techdocs.akamai.com/application-security/reference/get-policies-logging). _Products:_ All.
      externalDocs:
        description: See documentation for this operation in Akamai's Application Security API
        url: https://techdocs.akamai.com/application-security/reference/get-advanced-settings-logging
      operationId: get-advanced-settings-logging
      parameters:
      - description: For customers who manage more than one account, this [runs the operation from another account](https://techdocs.akamai.com/developer/docs/manage-many-accounts-with-one-api-client). The Identity and Access Management API provides a [list of available account switch keys](https://techdocs.akamai.com/iam-api/reference/get-client-account-switch-keys).
        example: '{{accountSwitchKey}}'
        in: query
        name: accountSwitchKey
        required: false
        schema:
          example: 1-5C0YLB:1-8BYUX
          type: string
      responses:
        '200':
          content:
            application/json:
              example:
                allowSampling: true
                cookies:
                  type: all
                customHeaders:
                  type: exclude
                  values:
                  - csdasdad
                standardHeaders:
                  type: only
                  values:
                  - Accept
              schema:
                additionalProperties: false
                description: The GET Response JSON for HTTP Header Logging.
                properties:
                  allowSampling:
                    description: Enables HTTP Header logging.
                    type: boolean
                  cookies:
                    additionalProperties: false
                    description: Settings for cookie headers.
                    properties:
                      type:
                        description: Use `all` to log headers for all requests with any standard header. Use `none` to exclude headers for any requests with any standard header from logging. Use `exclude` to exclude headers for requests with specific standard headers. Use `only` to include headers for requests with specific standard headers.
                        enum:
                        - all
                        - none
                        - exclude
                        - only
                        type: string
                      values:
                        description: List of headers to include or exclude depending on the `type` setting.
                        items:
                          type: string
                        type: array
                    required:
                    - type
                    type: object
                    x-akamai:
                      file-path: schemas/logging-header-setting.yaml
                  customHeaders:
                    additionalProperties: false
                    description: Settings for custom headers.
                    properties:
                      type:
                        description: Use `all` to log headers for all requests with any standard header. Use `none` to exclude headers for any requests with any standard header from logging. Use `exclude` to exclude headers for requests with specific standard headers. Use `only` to include headers for requests with specific standard headers.
                        enum:
                        - all
                        - none
                        - exclude
                        - only
                        type: string
                      values:
                        description: List of headers to include or exclude depending on the `type` setting.
                        items:
                          type: string
                        type: array
                    required:
                    - type
                    type: object
                    x-akamai:
                      file-path: schemas/logging-header-setting.yaml
                  standardHeaders:
                    additionalProperties: false
                    description: Settings for standard headers.
                    properties:
                      type:
                        description: Use `all` to log headers for all requests with any standard header. Use `none` to exclude headers for any requests with any standard header from logging. Use `exclude` to exclude headers for requests with specific standard headers. Use `only` to include headers for requests with specific standard headers.
                        enum:
                        - all
                        - none
                        - exclude
                        - only
                        type: string
                      values:
                        description: List of headers to include or exclude depending on the `type` setting.
                        items:
                          type: string
                        type: array
                    required:
                    - type
                    type: object
                    x-akamai:
                      file-path: schemas/logging-header-setting.yaml
                required:
                - allowSampling
                - cookies
                - customHeaders
                - standardHeaders
                type: object
                x-akamai:
                  file-path: schemas/header-logging-get-200.yaml
          description: Successfully retrieved the HTTP Header Logging settings.
        '400':
          content:
            application/json:
              example:
                detail: The request could not be understood by the server due to malformed syntax.
                instance: https://problems.luna.akamaiapis.net/appsec/error-instances/d54686b5-21cb-4ab7-a8d6-a92282cf1749
                status: 400
                title: Bad Request
                type: https://problems.luna.akamaiapis.net/appsec/error-types/BAD-REQUEST
              schema:
                additionalProperties: true
                description: Details the errors you can receive.
                properties:
                  detail:
                    description: The detailed error message.
                    type: string
                  fieldErrors:
                    additionalProperties:
                      description: Fields that provide additional details about the problem.
                      type: string
                    description: Pointers to fields for which invalid input was provided, whose values are messages detailing the reason this input was invalid for this field.
                    type: object
                  instance:
                    description: The non-referenceable URI that indicates the error instance.
                    example: https://problems.luna.akamaiapis.net/api-definitions/error-instances/d54686b5-21cb-4ab7-a8d6-a92282cf1749
                    type: string
                  status:
                    description: The HTTP status code.
                    example: 404
                    type: integer
                  title:
                    description: The error title.
                    example: Not Found
                    type: string
                  type:
                    description: The URL for the error type.
                    example: https://problems.luna.akamaiapis.net/api-definitions/error-types/NOT-FOUND
                    type: string
                required:
                - title
                - type
                - detail
                - instance
                - status
                type: object
                x-akamai:
                  file-path: schemas/problem-details.yaml
          description: '[Invalid](https://techdocs.akamai.com/application-security/reference/400). Client error, such as invalid or malformed input.'
          x-akamai:
            file-path: errors/400-client-read-errors.yaml
        '404':
          content:
            application/problem+json:
              example:
                detail: The requested resource is not found
                instance: https://problems.luna.akamaiapis.net/appsec/error-instances/d54686b5-21cb-4ab7-a8d6-a92282cf1749
                status: 404
                title: Not Found
                type: https://problems.luna.akamaiapis.net/appsec/error-types/NOT-FOUND
              schema:
                additionalProperties: true
                description: Details the errors you can receive.
                properties:
                  detail:
                    description: The detailed error message.
                    type: string
                  fieldErrors:
                    additionalProperties:
                      description: Fields that provide additional details about the problem.
                      type: string
                    description: Pointers to fields for which invalid input was provided, whose values are messages detailing the reason this input was invalid for this field.
                    type: object
                  instance:
                    description: The non-referenceable URI that indicates the error instance.
                    example: https://problems.luna.akamaiapis.net/api-definitions/error-instances/d54686b5-21cb-4ab7-a8d6-a92282cf1749
                    type: string
                  status:
                    description: The HTTP status code.
                    example: 404
                    type: integer
                  title:
                    description: The error title.
                    example: Not Found
                    type: string
                  type:
                    description: The URL for the error type.
                    example: https://problems.luna.akamaiapis.net/api-definitions/error-types/NOT-FOUND
                    type: string
                required:
                - title
                - type
                - detail
                - instance
                - status
                type: object
                x-akamai:
                  file-path: schemas/problem-details.yaml
          description: '[Not found](https://techdocs.akamai.com/application-security/reference/404). The named security policy doesn''t exist, doesn''t carry application layer controls, or no rule with this ID is available for use in this policy.'
          x-akamai:
            file-path: errors/404-client-read-errors.yaml
        '500':
          content:
            application/problem+json:
              example:
                detail: Internal Server Error
                instance: 12ab3c45-789d-01ef-2gh3-ijk4l56m78no
                status: 500
                title: Internal Server Error
                type: internal_server_error
              schema:
                additionalProperties: true
                description: Details the errors you can receive.
                properties:
                  detail:
                    description: The detailed error message.
                    type: string
                  fieldErrors:
                    additionalProperties:
                      description: Fields that provide additional details about the problem.
                      type: string
                    description: Pointers to fields for which invalid input was provided, whose values are messages detailing the reason this input was invalid for this field.
                    type: object
                  instance:
                    description: The non-referenceable URI that indicates the error instance.
                    example: https://problems.luna.akamaiapis.net/api-definitions/error-instances/d54686b5-21cb-4ab7-a8d6-a92282cf1749
                    type: string
                  status:
                    description: The HTTP status code.
                    example: 404
                    type: integer
                  title:
                    description: The error title.
                    example: Not Found
                    type: string
                  type:
                    description: The URL for the error type.
                    example: https://problems.luna.akamaiapis.net/api-definitions/error-types/NOT-FOUND
                    type: string
                required:
                - title
                - type
                - detail
                - instance
                - status
                type: object
                x-akamai:
                  file-path: schemas/problem-details.yaml
          description: '[Internal server error](https://techdocs.akamai.com/application-security/reference/500). Something went wrong on our side. Try again in a few minutes, and contact support if the error persists.'
          x-akamai:
            file-path: errors/500-server-errors.yaml
      summary: Akamai API Security Get the HTTP Header Log Settings for a Configuration
      tags:
      - HTTP header logs
    put:
      description: Enable, disable, or update HTTP header Logging settings for a configuration. This operation applies at the configuration level, and therefore applies to all policies within a configuration. If you want to override these settings for a specific policy, run [Modify HTTP header log settings](https://techdocs.akamai.com/application-security/reference/put-policies-logging). _Products:_ All.
      externalDocs:
        description: See documentation for this operation in Akamai's Application Security API
        url: https://techdocs.akamai.com/application-security/reference/put-advanced-settings-logging
      operationId: put-advanced-settings-logging
      parameters:
      - description: For customers who manage more than one account, this [runs the operation from another account](https://techdocs.akamai.com/developer/docs/manage-many-accounts-with-one-api-client). The Identity and Access Management API provides a [list of available account switch keys](https://techdocs.akamai.com/iam-api/reference/get-client-account-switch-keys).
        example: '{{accountSwitchKey}}'
        in: query
        name: accountSwitchKey
        required: false
        schema:
          example: 1-5C0YLB:1-8BYUX
          type: string
      requestBody:
        content:
          application/json:
            example:
              allowSampling: true
              cookies:
                type: all
              customHeaders:
                type: exclude
                values:
                - csdasdad
              standardHeaders:
                type: only
                values:
                - Accept
            schema:
              additionalProperties: false
              description: The PUT Request JSON for HTTP Header Logging.
              properties:
                allowSampling:
                  description: Whether to enable HTTP Header logging.
                  example: '{{allowSampling}}'
                  type: boolean
                cookies:
                  additionalProperties: false
                  description: Settings for cookie headers.
                  properties:
                    type:
                      description: Use `all` to log headers for all requests with any standard header. Use `none` to exclude headers for any requests with any standard header from logging. Use `exclude` to exclude headers for requests with specific standard headers. Use `only` to include headers for requests with specific standard headers.
                      enum:
                      - all
                      - none
                      - exclude
                      - only
                      type: string
                    values:
                      description: List of headers to include or exclude depending on the `type` setting.
                      items:
                        type: string
                      type: array
                  required:
                  - type
                  type: object
                  x-akamai:
                    file-path: schemas/logging-header-setting.yaml
                customHeaders:
                  additionalProperties: false
                  description: Settings for custom headers.
                  properties:
                    type:
                      description: Use `all` to log headers for all requests with any standard header. Use `none` to exclude headers for any requests with any standard header from logging. Use `exclude` to exclude headers for requests with specific standard headers. Use `only` to include headers for requests with specific standard headers.
                      enum:
                      - all
                      - none
                      - exclude
                      - only
                      type: string
                    values:
                      description: List of headers to include or exclude depending on the `type` setting.
                      items:
                        type: string
                      type: array
                  required:
                  - type
                  type: object
                  x-akamai:
                    file-path: schemas/logging-header-setting.yaml
                standardHeaders:
                  additionalProperties: false
                  description: Settings for standard headers.
                  properties:
                    type:
                      description: Use `all` to log headers for all requests with any standard header. Use `none` to exclude headers for any requests with any standard header from logging. Use `exclude` to exclude headers for requests with specific standard headers. Use `only` to include headers for requests with specific standard headers.
                      enum:
                      - all
                      - none
                      - exclude
                      - only
                      type: string
                    values:
                      description: List of headers to include or exclude depending on the `type` setting.
                      items:
                        type: string
                      type: array
                  required:
                  - type
                  type: object
                  x-akamai:
                    file-path: schemas/logging-header-setting.yaml
              required:
              - allowSampling
              type: object
              x-akamai:
                file-path: schemas/header-logging-put.yaml
        required: true
      responses:
        '200':
          content:
            application/json:
              example:
                allowSampling: true
                cookies:
                  type: all
                customHeaders:
                  type: exclude
                  values:
                  - csdasdad
                standardHeaders:
                  type: only
                  values:
                  - Accept
              schema:
                additionalProperties: false
                description: The PUT Response JSON for HTTP Header Logging.
                properties:
                  allowSampling:
                    description: Enables HTTP Header logging.
                    type: boolean
                  cookies:
                    additionalProperties: false
                    description: Settings for cookie headers.
                    properties:
                      type:
                        description: Use `all` to log headers for all requests with any standard header. Use `none` to exclude headers for any requests with any standard header from logging. Use `exclude` to exclude headers for requests with specific standard headers. Use `only` to include headers for requests with specific standard headers.
                        enum:
                        - all
                        - none
                        - exclude
                        - only
                        type: string
                      values:
                        description: List of headers to include or exclude depending on the `type` setting.
                        items:
                          type: string
                        type: array
                    required:
                    - type
                    type: object
                    x-akamai:
                      file-path: schemas/logging-header-setting.yaml
                  customHeaders:
                    additionalProperties: false
                    description: Settings for custom headers.
                    properties:
                      type:
                        description: Use `all` to log headers for all requests with any standard header. Use `none` to exclude headers for any requests with any standard header from logging. Use `exclude` to exclude headers for requests with specific standard headers. Use `only` to include headers for requests with specific standard headers.
                        enum:
                        - all
                        - none
                        - exclude
                        - only
                        type: string
                      values:
                        description: List of headers to include or exclude depending on the `type` setting.
                        items:
                          type: string
                        type: array
                    required:
                    - type
                    type: object
                    x-akamai:
                      file-path: schemas/logging-header-setting.yaml
                  standardHeaders:
                    additionalProperties: false
                    description: Settings for standard headers.
                    properties:
                      type:
                        description: Use `all` to log headers for all requests with any standard header. Use `none` to exclude headers for any requests with any standard header from logging. Use `exclude` to exclude headers for requests with specific standard headers. Use `only` to include headers for requests with specific standard headers.
                        enum:
                        - all
                        - none
                        - exclude
                        - only
                        type: string
                      values:
                        description: List of headers to include or exclude depending on the `type` setting.
                        items:
                          type: string
                        type: array
                    required:
                    - type
                    type: object
                    x-akamai:
                      file-path: schemas/logging-header-setting.yaml
                required:
                - allowSampling
                - cookies
                - customHeaders
                - standardHeaders
                type: object
                x-akamai:
                  file-path: schemas/header-logging-put-200.yaml
          description: Successfully updated the HTTP Header Logging settings:.
        '400':
          content:
            application/json:
              example:
                detail: The request could not be understood by the server due to malformed syntax.
                instance: https://problems.luna.akamaiapis.net/appsec/error-instances/d54686b5-21cb-4ab7-a8d6-a92282cf1749
                status: 400
                title: Bad Request
                type: https://problems.luna.akamaiapis.net/appsec/error-types/BAD-REQUEST
              schema:
                additionalProperties: true
                description: Details the errors you can receive.
                properties:
                  detail:
                    description: The detailed error message.
                    type: string
                  fieldErrors:
                    additionalProperties:
                      description: Fields that provide additional details about the problem.
                      type: string
                    description: Pointers to fields for which invalid input was provided, whose values are messages detailing the reason this input was invalid for this field.
                    type: object
                  instance:
                    description: The non-referenceable URI that indicates the error instance.
                    example: https://problems.luna.akamaiapis.net/api-definitions/error-instances/d54686b5-21cb-4ab7-a8d6-a92282cf1749
                    type: string
                  status:
                    description: The HTTP status code.
                    example: 404
                    type: integer
                  title:
                    description: The error title.
                    example: Not Found
                    type: string
                  type:
                    description: The URL for the error type.
                    example: https://problems.luna.akamaiapis.net/api-definitions/error-types/NOT-FOUND
                    type: string
                required:
                - title
                - type
                - detail
                - instance
                - status
                type: object
                x-akamai:
                  file-path: schemas/problem-details.yaml
          description: '[Invalid](https://techdocs.akamai.com/application-security/reference/400). Client error, such as invalid or malformed input.'
          x-akamai:
            file-path: errors/400-client-read-errors.yaml
        '403':
          content:
            application/problem+json:
              example:
                detail: You do not have the necessary access to perform this operation or the requested resource cannot be modified
                instance: https://problems.luna.akamaiapis.net/appsec/error-instances/d54686b5-21cb-4ab7-a8d6-a92282cf1749
                status: 403
                title: Forbidden
                type: https://problems.luna.akamaiapis.net/appsec-resource/error-types/ACCESS-DENIED
              schema:
                additionalProperties: true
                description: Details the errors you can receive.
                properties:
                  detail:
                    description: The detailed error message.
                    type: string
                  fieldErrors:
                    additionalProperties:
                      description: Fields that provide additional details about the problem.
                      type: string
                    description: Pointers to fields for which invalid input was provided, whose values are messages detailing the reason this input was invalid for this field.
                    type: object
                  instance:
                    description: The non-referenceable URI that indicates the error instance.
                    example: https://problems.luna.akamaiapis.net/api-definitions/error-instances/d54686b5-21cb-4ab7-a8d6-a92282cf1749
                    type: string
                  status:
                    description: The HTTP status code.
                    example: 404
                    type: integer
                  title:
                    description: The error title.
                    example: Not Found
                    type: string
                  type:
                    description: The URL for the error type.
                    example: https://problems.luna.akamaiapis.net/api-definitions/error-types/NOT-FOUND
                    type: string
                required:
                - title
                - type
                - detail
                - instance
                - status
                type: object
                x-akamai:
                  file-path: schemas/problem-details.yaml
          description: '[Forbidden](https://techdocs.akamai.com/application-security/reference/403). You don''t have permission to write to this resource.'
          x-akamai:
            file-path: errors/403-client-write-errors.yaml
        '404':
          content:
            application/problem+json:
              example:
                detail: The requested resource is not found
                instance: https://problems.luna.akamaiapis.net/appsec/error-instances/d54686b5-21cb-4ab7-a8d6-a92282cf1749
                status: 404
                title: Not Found
                type: https://problems.luna.akamaiapis.net/appsec/error-types/NOT-FOUND
              schema:
                additionalProperties: true
                description: Details the errors you can receive.
                properties:
                  detail:
                    description: The detailed error message.
                    type: string
                  fieldErrors:
                    additionalProperties:
                      description: Fields that provide additional details about the problem.
                      type: string
                    description: Pointers to fields for which invalid input was provided, whose values are messages detailing the reason this input was invalid for this field.
                    type: object
                  instance:
                    description: The non-referenceable URI that indicates the error instance.
                    example: https://problems.luna.akamaiapis.net/api-definitions/error-instances/d54686b5-21cb-4ab7-a8d6-a92282cf1749
                    type: string
                  status:
                    description: The HTTP status code.
                    example: 404
                    type: integer
                  title:
                    description: The error title.
                    example: Not Found
                    type: string
                  type:
                    description: The URL for the error type.
                    example: https://problems.luna.akamaiapis.net/api-definitions/error-types/NOT-FOUND
                    type: string
                required:
                - title
                - type
                - detail
                - instance
                - status
                type: object
                x-akamai:
                  file-path: schemas/problem-details.yaml
          description: '[Not found](https://techdocs.akamai.com/application-security/reference/404). The named security policy doesn''t exist, doesn''t carry application layer controls, or no rule with this ID is available for use in this policy.'
          x-akamai:
            file-path: errors/404-client-read-errors.yaml
        '500':
          content:
            application/problem+json:
              example:
                detail: Internal Server Error
                instance: 12ab3c45-789d-01ef-2gh3-ijk4l56m78no
                status: 500
                title: Internal Server Error
                type: internal_server_error
              schema:
               

# --- truncated at 32 KB (68 KB total) ---
# Full source: https://raw.githubusercontent.com/api-evangelist/akamai-api-security/refs/heads/main/openapi/akamai-api-security-http-header-logs-api-openapi.yml