Akamai Configuration version export API

openapi: 3.0.0
info:
  title: 'Akamai: API Endpoint Definition Access tokens Configuration version export API'
  version: '2'
  license:
    name: Apache 2.0
    url: https://www.apache.org/licenses/LICENSE-2.0.html
  description: 'Get comprehensive details about a security configuration

    version.'
servers:
- url: https://{hostname}/api-definitions/v2
tags:
- description: 'Get comprehensive details about a security configuration

    version.'
  name: Configuration version export
paths:
  /configs/{configId}/versions/{versionNumber}/export:
    parameters:
    - description: A unique identifier for each configuration.
      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.
      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-version-async-export.yaml
      path-info: /configs/{configId}/versions/{versionNumber}/export
    post:
      description: __All products__ Start an asynchronous export of a security configuration version. The response contains an `exportId` you can use to monitor progress and get the export data once it's ready.
      externalDocs:
        description: See documentation for this operation in Akamai's Application Security API
        url: https://techdocs.akamai.com/application-security/reference/post-export-config-version-async-task
      operationId: post-export-config-version-async-task
      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).
        in: query
        name: accountSwitchKey
        required: false
        schema:
          example: 1-5C0YLB:1-8BYUX
          type: string
      responses:
        '202':
          content:
            application/json:
              example:
                createdBy: jkowalski@example.com
                createdDate: '2025-08-06T10:44:05.016608Z'
                exportId: '161'
                exportStatus: PENDING
                retryAfter: 60
                statusLink: /appsec/v1/configs/24193/versions/39/export/161/status
              schema:
                additionalProperties: false
                description: Describes the response for an asynchronous export task.
                properties:
                  createdBy:
                    description: The user who launched the export task.
                    minLength: 1
                    type: string
                  createdDate:
                    description: __Read-only__ ISO 8601 timestamp when the export request begins.
                    format: date-time
                    readOnly: true
                    type: string
                  expiresDate:
                    description: ISO 8601 timestamp when the export result is deleted.
                    format: date-time
                    type: string
                  exportId:
                    description: Uniquely identifies each export task.
                    type: string
                  exportStatus:
                    description: "__Read-only__ The status of the export, which can take several minutes to complete. \n* `PENDING` indicates the task is accepted and in progress. \n* `COMPLETED` means it finished successfully and the result can be retrieved. \n* `FAILED` means the task could not be processed."
                    enum:
                    - PENDING
                    - COMPLETED
                    - FAILED
                    minLength: 1
                    readOnly: true
                    type: string
                  message:
                    description: A message providing additional information about the export task.
                    type: string
                  resultLink:
                    description: The URL for the operation to request the task result.
                    format: uri
                    type: string
                  retryAfter:
                    description: The estimated number of seconds until the task completes.
                    type: integer
                  statusLink:
                    description: The URL for the operation to request the task status.
                    format: uri
                    type: string
                required:
                - exportId
                - exportStatus
                - createdDate
                - createdBy
                type: object
                x-akamai:
                  file-path: schemas/export-async-status.yaml
          description: Successfully started exporting asynchronously.
          headers:
            Retry-After:
              description: The estimated number of seconds until the task completes. This header only appears for tasks still in progress.
              required: false
              schema:
                example: 60
                type: integer
              x-akamai:
                file-path: headers/retry-after.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:
                    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 aren''t authorized to run this operation.'
          x-akamai:
            file-path: errors/403.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:
                    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 security configuration version to export wasn''t found.'
          x-akamai:
            file-path: errors/404.yaml
        '409':
          content:
            application/problem+json:
              example:
                detail: An export task is already running. Please wait for the previous export task ('161') to complete before submitting a new one.
                instance: https://problems.luna.akamaiapis.net/appsec/error-instances/170237a02c617aa5
                status: 409
                title: Invalid Input Error
                type: https://problems.luna.akamaiapis.net/appsec/error-types/INVALID-INPUT-ERROR
              schema:
                additionalProperties: true
                description: Details the errors you can receive.
                properties:
                  detail:
                    description: The detailed error message.
                    type: string
                  fieldErrors:
                    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: '[Conflict](https://techdocs.akamai.com/application-security/reference/409). Invalid export request. See the `details` field provided in the response for more information.'
          x-akamai:
            file-path: errors/409-export-task.yaml
      summary: Asynchronously export a configuration version
      tags:
      - Configuration version export
      x-akamai:
        labels:
        - All products
  /configs/{configId}/versions/{versionNumber}/export/{exportId}/result:
    parameters:
    - description: A unique identifier for each configuration.
      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.
      in: path
      name: versionNumber
      required: true
      schema:
        example: 25
        type: integer
      x-akamai:
        file-path: parameters/version-number-path.yaml
    - description: A unique identifier for each asynchronous export.
      in: path
      name: exportId
      required: true
      schema:
        example: 101
        type: integer
      x-akamai:
        file-path: parameters/asynchronous-export-id.yaml
    x-akamai:
      file-path: paths/config-version-async-export-result.yaml
      path-info: /configs/{configId}/versions/{versionNumber}/export/{exportId}/result
    get:
      description: __All products__ Get a security configuration version's export data from a previously completed asynchronous task. This is only available when the task status is `COMPLETED`.
      externalDocs:
        description: See documentation for this operation in Akamai's Application Security API
        url: https://techdocs.akamai.com/application-security/reference/get-export-config-version-async-result
      operationId: get-export-config-version-async-result
      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).
        in: query
        name: accountSwitchKey
        required: false
        schema:
          example: 1-5C0YLB:1-8BYUX
          type: string
      responses:
        '200':
          content:
            application/json:
              example:
                advancedOptions:
                  asePenaltyBox:
                    akamaiManagedExclusions:
                      lastUpdated: '2025-02-01'
                      rules:
                      - '1000000'
                      - '2000000'
                      - '3000000'
                    blockDuration: 10
                    clientIdentifiers:
                    - ip-useragent
                    qualificationExclusions:
                      attackGroups:
                      - XSS
                      - IN
                      rules:
                      - 950002
                    requestCount: 1
                  ja4Fingerprint:
                    headerNames:
                    - test
                  logging:
                    allowSampling: true
                    cookies:
                      type: exclude
                      values:
                      - _updated_By_SoapUI
                      - w
                      - NEW_VAL_ADDED_BY_SoapUI
                    customHeaders:
                      type: only
                      values:
                      - '112'
                      - sdasd
                      - ds
                    standardHeaders:
                      type: only
                  pragmaHeader:
                    action: REMOVE
                    conditionOperator: AND
                    excludeCondition:
                    - header: Expect
                      positiveMatch: true
                      type: requestHeaderValueMatch
                      useHeaders: false
                      value:
                      - dasd
                      valueCase: true
                      valueWildcard: true
                    - positiveMatch: true
                      type: networkList
                      useHeaders: true
                      value:
                      - 62569_AEPUAT1PARTNERSSTRICTWL
                      valueCase: false
                      valueWildcard: false
                    override: true
                  prefetch:
                    allExtensions: false
                    enableAppLayer: true
                    enableRateControls: false
                    extensions:
                    - cgi
                    - jsp
                    - EMPTY_STRING
                    - aspx
                    - php
                    - py
                    - asp
                basedOn: 1
                configId: 48579
                configName: New Security Config
                createDate: '2017-09-08T22:24:41Z'
                createdBy: mrossi
                customDenyList: []
                customRules:
                - conditions:
                  - positiveMatch: true
                    type: hostMatch
                    value:
                    - a.com
                  - positiveMatch: true
                    type: asNumberMatch
                    useXForwardForHeaders: false
                    value:
                    - '1'
                  id: 60032441
                  name: test
                  operation: AND
                  ruleActivated: false
                  structured: true
                  tag:
                  - tag
                  version: 1
                errorHosts:
                - hostname: business.example.com
                  reason: property is not active in either production or staging
                  reasonCode: 400
                - hostname: anotherhostname.example.com
                  reason: You don't have access to this property
                  reasonCode: 403
                matchTargets:
                  apiTargets:
                  - apis:
                    - id: 1041
                      name: hmm test
                    bypassNetworkLists:
                    - id: 1024_AMAZONELASTICCOMPUTECLOU
                      name: Ec2 Akamai Network List
                    - id: 1283_MICROSOFTWINDOWSAZUREDAT
                      name: Azure IP range cloud services
                    effectiveSecurityControls:
                      applyApiConstraints: false
                      applyApplicationLayerControls: false
                      applyBotmanControls: false
                      applyNetworkLayerControls: false
                      applyRateControls: true
                      applyReputationControls: false
                      applySlowPostControls: false
                    id: 1362597
                    securityPolicy:
                      policyId: 99e_47293
                    sequence: 6
                    type: api
                  - apis:
                    - id: 1001
                      name: '1001'
                    - id: 1041
                      name: hmm test
                    bypassNetworkLists:
                    - id: 11212_BYPASSURR
                      name: bypass-URR
                    effectiveSecurityControls:
                      applyApiConstraints: true
                      applyApplicationLayerControls: false
                      applyBotmanControls: false
                      applyNetworkLayerControls: true
                      applyRateControls: false
                      applyReputationControls: true
                      applySlowPostControls: false
                    id: 1362598
                    securityPolicy:
                      policyId: '4444_44572'
                    sequence: 7
                    type: api
                  websiteTargets:
                  - bypassNetworkLists:
                    - id: 11212_BYPASSURR
                      name: bypass-URR
                    defaultFile: NO_MATCH
                    effectiveSecurityControls:
                      applyApiConstraints: true
                      applyApplicationLayerControls: true
                      applyBotmanControls: false
                      applyNetworkLayerControls: false
                      applyRateControls: true
                      applyReputationControls: false
                      applySlowPostControls: false
                    fileExtensions:
                    - jpg
                    filePaths:
                    - /path
                    id: 1362593
                    isNegativeFileExtensionMatch: false
                    isNegativePathMatch: false
                    securityPolicy:
                      policyId: qik3_38800
                    sequence: 1
                    type: website
                  - defaultFile: NO_MATCH
                    effectiveSecurityControls:
                      applyApiConstraints: true
                      applyApplicationLayerControls: true
                      applyBotmanControls: false
                      applyNetworkLayerControls: true
                      applyRateControls: true
                      applyReputationControls: true
                      applySlowPostControls: false
                    filePaths:
                    - /images
                    - /image1
                    - /path
                    hostnames:
                    - b2c.div1.akamaniac.com
                    id: 1362594
                    isNegativeFileExtensionMatch: false
                    isNegativePathMatch: false
                    securityPolicy:
                      policyId: qik2_38799
                    sequence: 2
                    type: website
                production:
                  status: Inactive
                ratePolicies:
                - averageThreshold: 3
                  burstThreshold: 2
                  clientIdentifier: ''
                  clientIdentifiers: []
                  createDate: '2017-09-08T22:24:42Z'
                  id: 672601
                  matchType: path
                  name: dsafsfdsf
                  pathMatchType: RequestDisabled
                  pathUriPositiveMatch: true
                  queryParameters:
                  - name: dasdasdasd*
                    positiveMatch: true
                    valueInRange: false
                    values:
                    - dasdasdas8*&^
                  requestType: ClientRequest
                  sameActionOnIpv6: true
                  type: BOTMAN
                  updateDate: '2017-09-08T22:24:42Z'
                  useXForwardForHeaders: false
                  used: false
                - additionalMatchOptions:
                  - positiveMatch: true
                    type: NetworkListCondition
                    values:
                    - 25620_REPUTATIONALLOWLIST174
                    - 11212_BYPASSURR
                  - positiveMatch: true
                    type: RequestMethodCondition
                    values:
                    - GET
                    - HTTP_DELETE
                  - positiveMatch: true
                    type: UserAgentCondition
                    values:
                    - MOZILLA
                    - Googlebot
                  - positiveMatch: true
                    type: RequestMethodCondition
                    values:
                    - GET
                    - POST
                    - HEAD
                  - positiveMatch: true
                    type: ResponseStatusCondition
                    values:
                    - '400'
                    - '401'
                    - '402'
                    - '403'
                    - '404'
                    - '405'
                    - '406'
                    - '407'
                    - '408'
                    - '409'
                    - '410'
                    - '500'
                    - '501'
                    - '502'
                    - '503'
                    - '504'
                  averageThreshold: 1000
                  burstThreshold: 10
                  burstWindow: 3
                  clientIdentifier: ip
                  condition:
                    atomicConditions:
                    - className: TlsFingerprintCondition
                      positiveMatch: true
                      value:
                      - a797dc449ef113be
                      - ba51ec8d71259a5b3c92d8787370e2c3
                    - className: ClientReputationCondition
                      name:
                      - DOSATCK
                      - WEBATCK
                      positiveMatch: true
                      sharedIpHandling: BOTH
                      value: 3
                    - className: RequestHeaderCondition
                      name:
                      - Accept
                      - Content-Type
                      nameWildcard: true
                      positiveMatch: true
                      value:
                      - json
                      - xml
                      valueCase: false
                      valueWildcard: true
                    positiveMatch: true
                  createDate: '2017-09-08T22:24:42Z'
                  description: These Shared Resources will be available to all policies within the Security Configuration
                  id: 672607
                  matchType: path
                  name: These Shared Resources will be available to all policies within the Security Configuration
                  pathMatchType: Custom
                  pathUriPositiveMatch: true
                  queryParameters:
                  - name: param1
                    positiveMatch: false
                    valueInRange: true
                    values:
                    - value1
                  requestType: ClientRequest
                  sameActionOnIpv6: true
                  type: WAF
                  updateDate: '2017-09-08T22:24:42Z'
                  useXForwardForHeaders: false
                  used: true
                reputationProfiles:
                - context: SCANTL
                  contextReadable: Scanning Tools
                  enabled: true
                  id: 210588
                  name: Scanning Tools (Low Threat)
                  threshold: 5
                - condition:
                    atomicConditions:
                    - className: RequestHeaderCondition
                      index: 1
                      name:
                      - test*
                      nameWildcard: false
                      positiveMatch: true
                      value:
                      - test*
                      valueCase: false
                      valueWildcard: false
                    - className: RequestHeaderCondition
                      index: 2
                      name:
                      - Head
                      - Header
                      nameWildcard: true
                      positiveMatch: true
                      value:
                      - Header value
                      valueCase: false
                      valueWildcard: true
                    - checkIps: connecting
                      className: NetworkListCondition
                      index: 3
                      positiveMatch: true
                      value:
                      - 14121_IMAGEMANAGERSERVERS
                    - className: RequestCookieCondition
                      index: 4
                      name: cookieName
                      nameCase: false
                      nameWildcard: true
                      positiveMatch: true
                      value:
                      - cookieValue
                      valueCase: false
                      valueWildcard: true
                    - checkIps: connecting
                      className: AsNumberCondition
                      index: 5
                      positiveMatch: true
                      value:
                      - '5'
                    canDelete: false
                    configVersionId: 152889
                    id: 88112456
                    name: Cloned of 87956156 for version 152889
                    positiveMatch: true
                    uuid: SEC_COND_88112456
                    version: 1504909482545
                  context: WEBATCK
                  contextReadable: Web Attackers
                  enabled: false
                  id: 210578
                  name: Web Attackers (Low Threat)
                  threshold: 5
                rulesets:
                - attackGroups:
                  - group: DDOS
                    groupName: Anomaly Score Exceeded for DDoS
                    threshold: 5
                  - group: IN
                    groupName: Anomaly Score Exceeded for Inbound
                    threshold: 30
                  - group: SQL
                    groupName: Anomaly Score Exceeded for SQL Injection
                    threshold: 19
                  - group: TROJAN
                    groupName: Anomaly Score Exceeded for Trojan
                    threshold: 4
                  - group: XSS
                    groupName: Anomaly Score Exceeded for Cross-Site Scripting
                    threshold: 9
                  id: 41
                  releaseDate: '2017-04-21T16:00:38Z'
                  rules:
                  - id: 699989
                    inspectRequestBody: false
                    inspectResponseBody: false
                    ruleVersion: 1
                    score: 5
                    tag: <AKAMAI/PRAGMA_DEFLECTION>
                    title: Akamai-X debug Pragma header detected and removed
                  - id: 699990
                    inspectRequestBody: false
                    inspectResponseBody: false
                    ruleVersion: 1
                    score: 5
                    tag: <AKAMAI/EDGESCAPE_ANONYMOUS_PROXY_v1>
                    title: Detected request from anonymous proxy
                  - attackGroups:
                    - SQL
                    - IN
                    id: 981252
                    inspectRequestBody: true
                    inspectResponseBody: false
                    ruleVersion: 4
                    score: 5
                    tag: <OWASP_CRS/WEB_ATTACK/SQL_INJECTION>
                    title: MySQL Charset Switch and MSSQL DoS Attempts
                  - attackGroups:
                    - IN
                    - DDOS
                    id: 3000060
                    inspectRequestBody: true
                    inspectResponseBody: false
                    ruleVersion: 2
                    score: 1000
                    tag: <AKAMAI/AUTOMATION/MALICIOUS>
                    title: Mirai / Kaiten DDoS Detection - HTTP Attacks
                  - attackGroups:
                    - XSS
                    - IN
                    id: 3000061
                    inspectRequestBody: true
                    inspectResponseBody: false
                    ruleVersion: 1
                    score: 5
                    tag: <AKAMAI/WEB_ATTACK/XSS>
                    title: Referer Header From OpenBugBounty Website - Potential XSS
                  rulesetVersionId: 327550
                  type: Kona
                securityPolicies:
                - hasRatePolicyWithApiKey: false
                  id: D3M0_98231
                  ipGeoFirewall:
                    block: blockSpecificIPGeo
                    ukraineGeoControl:
                      action: none
                  name: demo lab1
                  penaltyBox:
                    action: alert
                    penaltyBoxProtection: true
                  pragmaHeader:
                    action: REMOVE
                    conditionOperator: OR
                    excludeCondition:
                    - positiveMatch: false
                      type: ipMatch
                      useHeaders: false
                      value:
                      - 192.0.2.22
                      valueCase: false
                      valueWildcard: false
                    override: true
                  rapidRules:
                    defaultAction: alert
                    enabled: true
                    policyRule

# --- truncated at 32 KB (681 KB total) ---
# Full source: https://raw.githubusercontent.com/api-evangelist/akamai/refs/heads/main/openapi/akamai-configuration-version-export-api-openapi.yml