@itentialopensource/adapter-akamai_property_manager/report/adapter-openapi.yaml

This adapter integrates with the Akamai Property Manager API.

openapi: 3.0.0
info:
  title: Property Manager API
  description: >-
    Manage your Akamai delivery configurations with the Property Manager API.


    More information on https://developer.akamai.com/api/core_features/property_manager/v1.html


    Don't forget to set your environment with the following variables: (the values for first 4 variables come from the API credentials you downloaded on control.akamai.com. The network can have "staging" or "production")

    host

    access_token

    client_token

    client_secret


    Also two global variables should be set:

    baseUrl which should have a value of "https://{{host}}"

    network which should have a value of "staging" or "production"


    And additional global variable "accountSwitchKey" can be used by API credentials which have the permission to manage other accounts to indicate the account ID you want to manage
  contact: {}
  version: '1.0'
servers:
- url: https://akzz-xxxxxxxxxxxxxxxx-xxxxxxxxxxxxxxxx.luna.akamaiapis.net/papi/v1
  variables: {}
paths:
  /bulk/activations:
    post:
      tags:
      - activations
      summary: Bulkactivateasetofproperties
      description: >
        XXX Bulk activate a set of property versions.

        (Alternately, perform a bulk [fallback](doc:fast-validation) to the previous

        activation within an hour of the previous bulk activation.)

        Base the set of versions to activate on the results of a

        [bulk patch](https://dash.readme.com/project/papi-akamai/v1/refs/get_bulk-rules-patch-requests-bulkpatchid)

        operation, which you use to create a

        [BulkActivation](#bulkactivation) POST object.

        This operation launches an asynchronous process to update

        properties. To check its progress, run the

        [List bulk-activated properties](https://papi-akamai.readme.io/reference/bulkactivationsbulkactivationid#get_bulk-activations-bulkactivationid)

        operation, whose link is available in the `Location` header or

        `bulkActivationLink` member of this operation's response. See

        [Bulk Search and Update](doc:learn-about-bulk)

        for overall guidance on this feature.
      operationId: Bulkactivateasetofproperties
      parameters:
      - name: contractId
        in: query
        description: >-
          Optionally filters bulk searches to properties provisioned

          under the specified contract. For bulk operations, you can

          specify `contractId` and `groupId` independently from each

          other.
        required: true
        style: form
        explode: true
        schema:
          type: string
          example: '{{contractId}}'
      - name: groupId
        in: query
        description: >-
          Optionally filters bulk searches to properties provisioned

          under the specified group. For bulk operations, you can

          specify `contractId` and `groupId` independently from each

          other.
        required: true
        style: form
        explode: true
        schema:
          type: string
          example: '{{groupId}}'
      - name: PAPI-Use-Prefixes
        in: header
        description: (Required) Sets whether to display three-letter prefixes in various ID values in response data. This may override the client's default `usePrefixes` setting. See [ID Prefixes](doc:id-prefixes).
        required: true
        style: simple
        schema:
          type: string
          example: adipisicing anim et pariatur
      requestBody:
        description: ''
        content:
          application/json:
            schema:
              allOf:
              - $ref: '#/components/schemas/BulkactivateasetofpropertiesRequest'
              - example:
                  activatePropertyVersions:
                  - network: STAGING
                    note: Some activation note
                    propertyId: prp_1
                    propertyVersion: 2
                  - network: STAGING
                    note: Sample activation
                    notifyEmails:
                    - someoneElse@somewhere.com
                    propertyId: prp_15
                    propertyVersion: 3
                  - acknowledgeAllWarnings: false
                    acknowledgeWarnings:
                    - msg_123
                    - msg_234
                    network: PRODUCTION
                    note: created by xyz
                    propertyId: prp_3
                    propertyVersion: 11
                  defaultActivationSettings:
                    acknowledgeAllWarnings: true
                    fastPush: true
                    notifyEmails:
                    - you@example.com
                    - them@example.com
                    useFastFallback: false
            example:
              activatePropertyVersions:
              - network: STAGING
                note: Some activation note
                propertyId: prp_1
                propertyVersion: 2
              - network: STAGING
                note: Sample activation
                notifyEmails:
                - someoneElse@somewhere.com
                propertyId: prp_15
                propertyVersion: 3
              - acknowledgeAllWarnings: false
                acknowledgeWarnings:
                - msg_123
                - msg_234
                network: PRODUCTION
                note: created by xyz
                propertyId: prp_3
                propertyVersion: 11
              defaultActivationSettings:
                acknowledgeAllWarnings: true
                fastPush: true
                notifyEmails:
                - you@example.com
                - them@example.com
                useFastFallback: false
        required: true
      responses:
        '200':
          description: ''
          headers: {}
          content: {}
      deprecated: false
  /bulk/activations/{bulkActivationId}:
    get:
      tags:
      - activations
      summary: Listbulk-activatedproperties
      description: >
        List all activations that result from a [bulk activation request](https://papi-akamai.readme.io/reference/bulkactivations#post_bulk-activations), and poll the asynchronous process's status. Once the overall `bulkActivationStatus` is `COMPLETE`, check each activation's `activationStatus` to confirm it's `ACTIVATED`. The response is a [BulkActivation](#bulkactivation) GET object. See [Bulk Search and Update](doc:learn-about-bulk) for overall guidance on this feature.
      operationId: Listbulk-activatedproperties
      parameters:
      - name: contractId
        in: query
        description: >-
          Optionally filters bulk searches to properties provisioned

          under the specified contract. For bulk operations, you can

          specify `contractId` and `groupId` independently from each

          other.
        required: true
        style: form
        explode: true
        schema:
          type: string
          example: '{{contractId}}'
      - name: groupId
        in: query
        description: >-
          Optionally filters bulk searches to properties provisioned

          under the specified group. For bulk operations, you can

          specify `contractId` and `groupId` independently from each

          other.
        required: true
        style: form
        explode: true
        schema:
          type: string
          example: '{{groupId}}'
      - name: bulkActivationId
        in: path
        description: (Required) Identifies each bulk activation job.
        required: true
        style: simple
        schema:
          type: string
          example: '{{bulkActivationId}}'
      - name: PAPI-Use-Prefixes
        in: header
        description: (Required) Sets whether to display three-letter prefixes in various ID values in response data. This may override the client's default `usePrefixes` setting. See [ID Prefixes](doc:id-prefixes).
        required: true
        style: simple
        schema:
          type: string
          example: adipisicing anim et pariatur
      responses:
        '200':
          description: ''
          headers: {}
          content: {}
      deprecated: false
  /properties/{propertyId}/activations:
    get:
      tags:
      - activations
      summary: Listactivations
      description: >
        This lists all activations for all versions of a property, on both production and staging networks.
      operationId: Listactivations
      parameters:
      - name: contractId
        in: query
        description: >-
          Unique identifier for the contract.

          The parameter is optional if the property has been

          provisioned under only one contract.

          Otherwise you need to specify it along with the `groupId`.

          (In other operations that don't specify a `propertyId` URL

          parameter, this parameter is always required.)

          See [ID prefixes](doc:id-prefixes)

          for details on omitting the value's `ctr_` prefix.
        required: true
        style: form
        explode: true
        schema:
          type: string
          example: '{{contractId}}'
      - name: groupId
        in: query
        description: >-
          Unique identifier for the group.

          The parameter is optional if the property has been

          provisioned under only one group.

          Otherwise you need to specify it along with the `contractId`.

          (In other operations that don't specify a `propertyId` URL

          parameter, this parameter is always required.)

          See [ID prefixes](doc:id-prefixes)

          for details on omitting the value's `grp_` prefix.
        required: true
        style: form
        explode: true
        schema:
          type: string
          example: '{{groupId}}'
      - name: propertyId
        in: path
        description: >-
          (Required) Unique identifier for the property.

          See [ID prefixes](doc:id-prefixes)

          for details on omitting the value's `prp_` prefix.
        required: true
        style: simple
        schema:
          type: string
          example: '{{propertyId}}'
      - name: PAPI-Use-Prefixes
        in: header
        description: (Required) Sets whether to display three-letter prefixes in various ID values in response data. This may override the client's default `usePrefixes` setting. See [ID Prefixes](doc:id-prefixes).
        required: true
        style: simple
        schema:
          type: string
          example: adipisicing anim et pariatur
      responses:
        '200':
          description: ''
          headers: {}
          content: {}
      deprecated: false
    post:
      tags:
      - activations
      summary: Createanewactivationordeactivation
      description: >
        This operation creates a new property activation, which

        deactivates any current activation. After a necessary delay,

        this activates your property version's rule tree and set of

        hostnames across Akamai's network of edge servers, modifying how

        your edge content responds to end-user requests.

        If there's a problem with the property you activated, you may

        have the option to fall back to the previous version. Within an

        hour of activating, POSTing another activation with

        `\"useFastFallback\":true` in the request object disables the

        current activation and falls back to the previous version. This

        fallback takes a few seconds, but the option is available only

        if there have been no changes to the set of property hostnames,

        as indicated by the

        [`canFastFallback`](#8b3213c5)

        member.


        If the activation request produces warnings, a 400 response

        indicates this problem message: `{"type":

        "/papi/v0/activation-warnings-not-acknowledged"}`. Subsequent

        requests succeed if you list the `messageId` values in the

        request's `acknowledgeWarnings` array. Once an activation is

        successful, it responds with a 201 code and provides a

        `Location` header and `activationLink` in the response

        object indicating where to poll the status of the

        activation.


        > __Note__. If you set `activationType` to `DEACTIVATE` in

        the POST request object, the property would deactivate and

        no longer serve any traffic. You'd need to modify your DNS

        configuration and specify a different way to handle the

        traffic. See [Enable traffic for a new edge

        hostname](doc:enable-traffic-for-a-new-edge-hostname) for more information.
      operationId: Createanewactivationordeactivation
      parameters:
      - name: contractId
        in: query
        description: >-
          Unique identifier for the contract.

          The parameter is optional if the property has been

          provisioned under only one contract.

          Otherwise you need to specify it along with the `groupId`.

          (In other operations that don't specify a `propertyId` URL

          parameter, this parameter is always required.)

          See [ID prefixes](doc:id-prefixes)

          for details on omitting the value's `ctr_` prefix.
        required: true
        style: form
        explode: true
        schema:
          type: string
          example: '{{contractId}}'
      - name: groupId
        in: query
        description: >-
          Unique identifier for the group.

          The parameter is optional if the property has been

          provisioned under only one group.

          Otherwise you need to specify it along with the `contractId`.

          (In other operations that don't specify a `propertyId` URL

          parameter, this parameter is always required.)

          See [ID prefixes](doc:id-prefixes)

          for details on omitting the value's `grp_` prefix.
        required: true
        style: form
        explode: true
        schema:
          type: string
          example: '{{groupId}}'
      - name: propertyId
        in: path
        description: >-
          (Required) Unique identifier for the property.

          See [ID prefixes](doc:id-prefixes)

          for details on omitting the value's `prp_` prefix.
        required: true
        style: simple
        schema:
          type: string
          example: '{{propertyId}}'
      - name: PAPI-Use-Prefixes
        in: header
        description: (Required) Sets whether to display three-letter prefixes in various ID values in response data. This may override the client's default `usePrefixes` setting. See [ID Prefixes](doc:id-prefixes).
        required: true
        style: simple
        schema:
          type: string
          example: adipisicing anim et pariatur
      requestBody:
        description: ''
        content:
          application/json:
            schema:
              allOf:
              - $ref: '#/components/schemas/CreateanewactivationordeactivationRequest'
              - example:
                  acknowledgeWarnings:
                  - msg_baa4560881774a45b5fd25f5b1eab021d7c40b4f
                  network: STAGING
                  note: Sample activation
                  notifyEmails:
                  - you@example.com
                  - them@example.com
                  propertyVersion: 1
                  useFastFallback: false
            example:
              acknowledgeWarnings:
              - msg_baa4560881774a45b5fd25f5b1eab021d7c40b4f
              network: STAGING
              note: Sample activation
              notifyEmails:
              - you@example.com
              - them@example.com
              propertyVersion: 1
              useFastFallback: false
        required: true
      responses:
        '200':
          description: ''
          headers: {}
          content: {}
      deprecated: false
  /bulk/property-version-creations:
    post:
      tags:
      - property-version-creations
      summary: Bulkversionasetofproperties
      description: >
        POST a [BulkVersion](#bulkversion) object to create new

        versions of a set of properties based on any previous version.

        This operation launches an asynchronous process to increment

        versions. To check its progress,

        run the [List bulk-versioned properties](https://papi-akamai.readme.io/reference/bulkproperty-version-creationsbulkcreateid#get_bulk-property-version-creations-bulkcreateid)

        operation, whose link is available in the `Location` header or

        `bulkCreateVersionLink` member of this operation's response.

        Run this operation only after

        [bulk searching](https://papi-akamai.readme.io/reference/bulkrules-search-requests#post_bulk-rules-search-requests) a set of properties you want

        to change, to prepare new versions to bulk patch. See

        [Bulk Search and Update](doc:learn-about-bulk)

        for guidance on this feature.
      operationId: Bulkversionasetofproperties
      parameters:
      - name: contractId
        in: query
        description: >-
          Optionally filters bulk searches to properties provisioned

          under the specified contract. For bulk operations, you can

          specify `contractId` and `groupId` independently from each

          other.
        required: true
        style: form
        explode: true
        schema:
          type: string
          example: '{{contractId}}'
      - name: groupId
        in: query
        description: >-
          Optionally filters bulk searches to properties provisioned

          under the specified group. For bulk operations, you can

          specify `contractId` and `groupId` independently from each

          other.
        required: true
        style: form
        explode: true
        schema:
          type: string
          example: '{{groupId}}'
      - name: PAPI-Use-Prefixes
        in: header
        description: (Required) Sets whether to display three-letter prefixes in various ID values in response data. This may override the client's default `usePrefixes` setting. See [ID Prefixes](doc:id-prefixes).
        required: true
        style: simple
        schema:
          type: string
          example: adipisicing anim et pariatur
      requestBody:
        description: ''
        content:
          application/json:
            schema:
              allOf:
              - $ref: '#/components/schemas/BulkversionasetofpropertiesRequest'
              - example:
                  createPropertyVersions:
                  - createFromVersion: 1
                    createFromVersionEtag: 2641910c585cf67b
                    propertyId: prp_1
                  - createFromVersion: 2
                    createFromVersionEtag: 343410c585cf67fc
                    propertyId: prp_15
                  - createFromVersion: 10
                    createFromVersionEtag: 6c7v5c65c6cvcv65
                    propertyId: prp_3
            example:
              createPropertyVersions:
              - createFromVersion: 1
                createFromVersionEtag: 2641910c585cf67b
                propertyId: prp_1
              - createFromVersion: 2
                createFromVersionEtag: 343410c585cf67fc
                propertyId: prp_15
              - createFromVersion: 10
                createFromVersionEtag: 6c7v5c65c6cvcv65
                propertyId: prp_3
        required: true
      responses:
        '200':
          description: ''
          headers: {}
          content: {}
      deprecated: false
  /bulk/property-version-creations/{bulkCreateId}:
    get:
      tags:
      - property-version-creations
      summary: Listbulk-versionedproperties
      description: >
        List all new property versions that result from a [bulk versioning request](https://papi-akamai.readme.io/reference/bulkproperty-version-creations#post_bulk-property-version-creations), and poll the asynchronous process's status. The response is a [BulkVersion](#bulkversion) GET object. After the `bulkCreateVersionsStatus` is `COMPLETE`, use the new version numbers along with search paths from a [bulk search](https://papi-akamai.readme.io/reference/bulkrules-search-requests#post_bulk-rules-search-requests) operation to [bulk patch](https://papi-akamai.readme.io/reference/bulkrules-patch-requests#post_bulk-rules-patch-requests) them. See [Bulk Search and Update](doc:learn-about-bulk) for guidance.
      operationId: Listbulk-versionedproperties
      parameters:
      - name: contractId
        in: query
        description: >-
          Optionally filters bulk searches to properties provisioned

          under the specified contract. For bulk operations, you can

          specify `contractId` and `groupId` independently from each

          other.
        required: true
        style: form
        explode: true
        schema:
          type: string
          example: '{{contractId}}'
      - name: groupId
        in: query
        description: >-
          Optionally filters bulk searches to properties provisioned

          under the specified group. For bulk operations, you can

          specify `contractId` and `groupId` independently from each

          other.
        required: true
        style: form
        explode: true
        schema:
          type: string
          example: '{{groupId}}'
      - name: bulkCreateId
        in: path
        description: (Required) Identifies each bulk-versioning job.
        required: true
        style: simple
        schema:
          type: string
          example: '{{bulkCreateId}}'
      - name: PAPI-Use-Prefixes
        in: header
        description: (Required) Sets whether to display three-letter prefixes in various ID values in response data. This may override the client's default `usePrefixes` setting. See [ID Prefixes](doc:id-prefixes).
        required: true
        style: simple
        schema:
          type: string
          example: adipisicing anim et pariatur
      responses:
        '200':
          description: ''
          headers: {}
          content: {}
      deprecated: false
  /bulk/rules-patch-requests:
    post:
      tags:
      - rules-patch-requests
      summary: Bulkpatchasetofproperties
      description: >
        Apply a series of JSON Patch

        operations to modify a set of property versions. Form this set

        of `patches` based on the

        [JSONPath](http://goessner.net/articles/JsonPath/) locations

        from a [bulk search](https://papi-akamai.readme.io/reference/bulkrules-search-requests#post_bulk-rules-search-requests) response. Specify a set

        of new property versions based on the results of a

        [bulk versioning](https://papi-akamai.readme.io/reference/bulkproperty-version-creations#post_bulk-property-version-creations) operation. The

        request is a [BulkPatch](#bulkpatch) POST object. This

        operation launches an asynchronous process to update rule

        trees. To check its progress, run the [List bulk-updated

        properties](https://papi-akamai.readme.io/reference/bulkrules-patch-requestsbulkpatchid#get_bulk-rules-patch-requests-bulkpatchid) operation, whose link is available

        in the `Location` header or `bulkPatchLink` member of this

        operation's response. See

        [Bulk Search and Update](doc:learn-about-bulk)

        for overall guidance on this feature.
      operationId: Bulkpatchasetofproperties
      parameters:
      - name: contractId
        in: query
        description: >-
          Optionally filters bulk searches to properties provisioned

          under the specified contract. For bulk operations, you can

          specify `contractId` and `groupId` independently from each

          other.
        required: true
        style: form
        explode: true
        schema:
          type: string
          example: '{{contractId}}'
      - name: groupId
        in: query
        description: >-
          Optionally filters bulk searches to properties provisioned

          under the specified group. For bulk operations, you can

          specify `contractId` and `groupId` independently from each

          other.
        required: true
        style: form
        explode: true
        schema:
          type: string
          example: '{{groupId}}'
      - name: PAPI-Use-Prefixes
        in: header
        description: (Required) Sets whether to display three-letter prefixes in various ID values in response data. This may override the client's default `usePrefixes` setting. See [ID Prefixes](doc:id-prefixes).
        required: true
        style: simple
        schema:
          type: string
          example: adipisicing anim et pariatur
      requestBody:
        description: ''
        content:
          application/json:
            schema:
              allOf:
              - $ref: '#/components/schemas/BulkpatchasetofpropertiesRequest'
              - example:
                  patchPropertyVersions:
                  - etag: a87v5c65c6821bc
                    patches:
                    - op: replace
                      path: /rules/children/1/features/3/option/enabled
                      value: on
                    - op: replace
                      path: /rules/children/1/features/0/option/enabled
                      value: on
                    propertyId: prp_1
                    propertyVersion: 1
                  - etag: 6c7v5c65c6cvcv65
                    patches:
                    - op: replace
                      path: /rules/children/1/children/0/features/1/enabled
                      value: on
                    propertyId: prp_15
                    propertyVersion: 2
                  - etag: 1f8903bcde2f3
                    patches:
                    - op: replace
                      path: /rules/children/0/children/1/children/2/features/1/enabled
                      value: on
                    propertyId: prp_3
                    propertyVersion: 10
            example:
              patchPropertyVersions:
              - etag: a87v5c65c6821bc
                patches:
                - op: replace
                  path: /rules/children/1/features/3/option/enabled
                  value: on
                - op: replace
                  path: /rules/children/1/features/0/option/enabled
                  value: on
                propertyId: prp_1
                propertyVersion: 1
              - etag: 6c7v5c65c6cvcv65
                patches:
                - op: replace
                  path: /rules/children/1/children/0/features/1/enabled
                  value: on
                propertyId: prp_15
                propertyVersion: 2
              - etag: 1f8903bcde2f3
                patches:
                - op: replace
                  path: /rules/children/0/children/1/children/2/features/1/enabled
                  value: on
                propertyId: prp_3
                propertyVersion: 10
        required: true
      responses:
        '200':
          description: ''
          headers: {}
          content: {}
      deprecated: false
  /bulk/rules-patch-requests/{bulkPatchId}:
    get:
      tags:
      - rules-patch-requests
      summary: Listbulk-patchedproperties
      description: >
        List all modified property versions that result from a [bulk patch](https://papi-akamai.readme.io/reference/bulkrules-patch-requests#post_bulk-rules-patch-requests) request, and poll the asynchronous process's status. The response is a [BulkPatch](#bulkpatch) object. Once the overall `bulkPatchStatus` is `COMPLETE`, you can feed all successfully updated property versions whose `status` is `UPDATED` into a subsequent request to [bulk activate](https://papi-akamai.readme.io/reference/bulkactivations#post_bulk-activations) them. See [Bulk Search and Update](doc:learn-about-bulk) for overall guidance on this feature.
      operationId: Listbulk-patchedproperties
      parameters:
      - name: contractId
        in: query
        description: >-
          Optionally filters bulk searches to properties provisioned

          under the specified contract. For bulk operations, you can

          specify `contractId` and `groupId` independently from each

          other.
        required: true
        style: form
        explode: true
        schema:
          type: string
          example: '{{contractId}}'
      - name: groupId
        in: query
        description: >-
          Optionally filters bulk searches to properties provisioned

          under the specified group. For bulk operations, you can

          specify `contractId` and `groupId` independently from each

          other.
        required: true
        style: form
        explode: true
        schema:
          type: string
          example: '{{groupId}}'
      - name: bulkPatchId
        in: path
        description: (Required) Identifies each bulk patch job.
        required: true
        style: simple
        schema:
          type: string
          example: '{{bulkPatchId}}'
      - name: PAPI-Use-Prefixes
        in: header
        description: (Required) Sets whether to display three-letter prefixes in various ID values in response data. This may override the client's default `usePrefixes` setting. See [ID Prefixes](doc:id-prefixes).
        required: true
        style: simple
        schema:
          type: string
          example: adipisicing anim et pariatur
      responses:
        '200':
          description: ''
          headers: {}
          content: {}
      deprecated: false
  /bulk/rules-search-requests:
    post:
      tags:
      - rules-search-requests
      summary: Bulksearchasetofproperties
      description: >
        POST a

        [BulkSearch](#bulksearch) object to search across all active

        property versions, specifying a

        [JSONPath](http://goessner.net/articles/JsonPath/) expression to

        match their rule trees. This operation launches an asynchronous

        process to gather search results. To check its progress, run the

        [List bulk search results](https://papi-akamai.readme.io/reference/bulkrules-search-requestsbulksearchid#get_bulk-rules-search-requests-bulksearchid) operation, whose link

        is available in the `Location` header or the `bulkSearchLink`

        member of this operation's response. After gathering completed

        results, you can create new property versions, bulk patch the

        rule trees, then activate them. See

        [Bulk Search and Update](doc:learn-about-bulk)

        for guidance on this feature.

        Run [Synchronously bulk search a set of

        properties](https://papi-akamai.readme.io/reference/bulkrules-search-requests#post_bulk-rules-search-requestssynchronus) as an alternative to

        get completed search results directly.

        To perform simpler

        searches for a property's name or hostnames to which it applies,

        run the [Search properties](https://papi-akamai.readme.io/reference/searchfind-by-value#post_search-find-by-value) operation instead.
      operationId: Bulksearchasetofproperties
      parameters:
      - name: contractId
        in: query
        description: >-
          Optionally filters bulk searches to properties provisioned

          under the specified contract. For bulk operations, you can

          specify `contractId` and `groupId` independently from each

          other.
        required: true
        style: form
        explode: true
        schema:
          type: string
          example: '{{contractId}}'
      - name: groupId
        in: query
        description: >-
          Optionally filters bulk searches to properties provisioned

          under the specified group. For bulk operations, you can

          specify `contractId` and `groupId` independently from each

          other.
        required: true
        style: form
        explode: true
        schema:
          type: string
          example: '{{groupId}}'
      - name: PAPI-Use-Prefixes
        in: header
        description: (Required) Sets whether to display three-letter prefixes in various ID values in response data. This may override the client's default `usePrefixes` setting. See [ID Prefixes](doc:id-prefixes).
        required: true
        style: simple
        schema:
          type: string
          example: adipisicing anim et pariatur
      requestBody:
        description: ''
        content:
          application/json:
            schema:
              allOf:
              - $ref: '#/components/schemas/BulksearchasetofpropertiesRequest'
              - example:
                  bulkSearchQuery:
                    bulkSearchQualifiers:
                    - $.options[?(@.secure=="true")]
                    - $..features[?(@.name=="origin")].options[?(@.hostname=="old.origin.example.com")]
                    match: $..conditions[?(@.name == "ext" && "mp3" in @.options.value && "mp4" nin @.options.value)].options.value[?(@ == "mp3")]
                    syntax: JSONPATH
            example:
              bulkSearchQuery:
                bulkSearchQualifiers:
                - $.options[?(@.secure=="true")]
                - $..features[?(@.name=="origin")].options[?(@.hostname=="old.origin.example.com")]
                match: $..conditions[?(@.name == "ext" && "mp3" in @.options.value && "mp4" nin @.options.value)].options.value[?(@ == "mp3")]
                syntax: JSONPATH
        required: true
      responses:
        '200':
          description: ''
          headers: {}
          content: {}
      deprecated: false
  /bulk/rules-search-requests/{bulkSearchId}:
    get:
      tags:
      - rules-search-requests
      summary: Listbulksearchresults
      description: >
        List all property versions that result from a [bulk search request](https://papi-akamai.readme.io/reference/bulkrules-search-requests#post_bulk-rules-search-requests). Run this operation to poll the asynchronous process's status. The response is a [BulkSearch](#bulksearch) GET object. Once the `searchTargetStatus` is `COMPLETE`, you can feed the `results` into a [bulk versioning](https://papi-akamai.readme.io/reference/bulkproperty-version-creations#post_bulk-property-version-creations) operation. Also use the JSON path `matchLocations` to run a [bulk patch](https://papi-akamai.readme.io/reference/bulkrules-patch-requests#post_bulk-rules-patch-requests) operation over the rule trees. See [Bulk Search and Update](doc:learn-about-bulk) for guidance.
      operationId: Listbulksearchresults
      parameters:
      - name: contractId
        in: query
        description: >-
          Optionally filters bulk searches to properties provisioned

          under the specified contract. For bulk operations, you can

          specify `contractId` and `groupId` independently from each

          other.
        required: true
        style: form
        explode: true
        schema:
          type: string
          example: '{{contractId}}'
      - name: groupId
        in: query
        description: >-
          Optionally filters bulk searches to properties provisioned

          under the specified group. For bulk operations, you can

          specify `contractId` and `groupId` independently from each

          other.
        required: true
        style: form
        explode: true
        schema:
          type: string
          example: '{{groupId}}'
      - name: bulkSearchId
        in: path
        description: (Required) Identifies each bulk search job.
        required: true
        style: simple
        schema:
          type: string
          example: '{{bulkSearchId}}'
      - name: PAPI-Use-Prefixes
        in: header
        description: (Required) Sets whether to display three-letter prefixes in various ID values in response data. This may override the client's default `usePrefixes` setting. See [ID Prefixes](doc:id-prefixes).
        required: true
        style: simple
        schema:
          type: string
          example: adipisicing anim et pariatur
      responses:
        '200':
          description: ''
          headers: {}
          content: {}
      deprecated: false
  /bulk/rules-search-requests-synch:
    post:
      tags:
      - bulk
      summary: Synchronouslybulksearchasetofproperties
      description: >
        Provides an alternative to the asynchronous [Bulk search a set of

        properties](https://papi-akamai.readme.io/reference/bulkrules-search-requests#post_bulk-rules-search-requests) operation. It yields completed

        bulk search results directly, but with possibly high latency,

        making it more appropriate to target for small-batch searches.

        POST a [BulkSearch](#bulksearch) object to search across all

        active property versions, specifying a

        [JSONPath](http://goessner.net/articles/JsonPath/) expression to

        match their rule trees. After gathering results, you can create

        new property versions, bulk patch the rule trees, then activate

        them. See [Bulk Search and Update](doc:learn-about-bulk) for

        guidance on this feature.

        To perform simpler searches for a property's name or hostnames

        to which it applies, run the [Search

        properties](https://papi-akamai.readme.io/reference/searchfind-by-value#post_search-find-by-value) operation instead.
      operationId: Synchronouslybulksearchasetofproperties
      parameters:
      - name: contractId
        in: query
        description: >-
          Optionally filters bulk searches to properties provisioned

          under the specified contract. For bulk operations, you can

          specify `contractId` and `groupId` independently from each

          other.
        required: true
        style: form
        explode: true
        schema:
          type: string
          example: '{{contractId}}'
      - name: groupId
        in: query
        description: >-
          Optionally filters bulk searches to properties provisioned

          under the specified group. For bulk operations, you can

          specify `contractId` and `groupId` independently from each

          other.
        required: true
        style: form
        explode: true
        schema:
          type: string
          example: '{{groupId}}'
      - name: PAPI-Use-Prefixes
        in: header
        description: (Required) Sets whether to display three-letter prefixes in various ID values in response data. This may override the client's default `usePrefixes` setting. See [ID Prefixes](doc:id-prefixes).
        required: true
        style: simple
        schema:
          type: string
          example: adipisicing anim et pariatur
      requestBody:
        description: ''
        content:
          application/json:
            schema:
              allOf:
              - $ref: '#/components/schemas/SynchronouslybulksearchasetofpropertiesRequest'
              - example:
                  bulkSearchQuery:
                    bulkSearchQualifiers:
                    - $.options[?(@.secure=="true")]
                    - $..features[?(@.name=="origin")].options[?(@.hostname=="old.origin.example.com")]
                    match: $..conditions[?(@.name == "ext" && "mp3" in @.options.value && "mp4" nin @.options.value)].options.value[?(@ == "mp3")]
                    syntax: JSONPATH
            example:
              bulkSearchQuery:
                bulkSearchQualifiers:
                - $.options[?(@.secure=="true")]
                - $..features[?(@.name=="origin")].options[?(@.hostname=="old.origin.example.com")]
                match: $..conditions[?(@.name == "ext" && "mp3" in @.options.value && "mp4" nin @.options.value)].options.value[?(@ == "mp3")]
                syntax: JSONPATH
        required: true
      responses:
        '200':
          description: ''
          headers: {}
          content: {}
      deprecated: false
  /client-settings:
    get:
      tags:
      - client-settings
      summary: Getclientsettings
      description: >
        Get the current set of default values that apply to API clients keyed by the current authorization token.
      operationId: Getclientsettings
      parameters: []
      responses:
        '200':
          description: ''
          headers: {}
          content: {}
      deprecated: false
    put:
      tags:
      - client-settings
      summary: Updateclientsettings
      description: >
        Update the current set of default values

        that apply to API clients keyed by the current authorization

        token.
      operationId: Updateclientsettings
      parameters: []
      requestBody:
        description: ''
        content:
          application/json:
            schema:
              allOf:
              - $ref: '#/components/schemas/UpdateclientsettingsRequest'
              - example:
                  ruleFormat: v2015-08-08
                  usePrefixes: true
            example:
              ruleFormat: v2015-08-08
              usePrefixes: true
        required: true
      responses:
        '200':
          description: ''
          headers: {}
          content: {}
      deprecated: false
  /cpcodes:
    get:
      tags:
      - cpcodes
      summary: ListCPcodes
      description: >
        This operation lists CP codes available within your contract and group pairing, which you assign to a property within its rule tree. CP codes include information about the product under which they were generated. When [creating a new property](https://papi-akamai.readme.io/reference/properties#post_properties), you should apply the same product under which the associated CP code was created.
      operationId: ListCPcodes
      parameters:
      - name: contractId
        in: query
        description: >-
          (Required) Unique identifier for the contract.

          See [ID prefixes](doc:id-prefixes)

          for details on omitting the value's `ctr_` prefix.
        required: true
        style: form
        explode: true
        schema:
          type: string
          example: '{{contractId}}'
      - name: groupId
        in: query
        description: >-
          (Required) Unique identifier for the group.

          See [ID prefixes](doc:id-prefixes)

          for details on omitting the value's `grp_` prefix.
        required: true
        style: form
        explode: true
        schema:
          type: string
          example: '{{groupId}}'
      - name: PAPI-Use-Prefixes
        in: header
        description: (Required) Sets whether to display three-letter prefixes in various ID values in response data. This may override the client's default `usePrefixes` setting. See [ID Prefixes](doc:id-prefixes).
        required: true
        style: simple
        schema:
          type: string
          example: adipisicing anim et pariatur
      responses:
        '200':
          description: ''
          headers: {}
          content: {}
      deprecated: false
    post:
      tags:
      - cpcodes
      summary: CreateanewCPcode
      description: >
        To create a new CP code, you need to

        associate it with a product. You can assign any CP code within

        a property's rule tree as detailed in the

        [Rule Trees](doc:rule-trees)

        section. You should match the same `productId` that's assigned

        to properties that invoke the CP code to the one assigned to the

        CP code, otherwise you may get a warning.
      operationId: CreateanewCPcode
      parameters:
      - name: contractId
        in: query
        description: >-
          (Required) Unique identifier for the contract.

          See [ID prefixes](doc:id-prefixes)

          for details on omitting the value's `ctr_` prefix.
        required: true
        style: form
        explode: true
        schema:
          type: string
          example: '{{contractId}}'
      - name: groupId
        in: query
        description: >-
          (Required) Unique identifier for the group.

          See [ID prefixes](doc:id-prefixes)

          for details on omitting the value's `grp_` prefix.
        required: true
        style: form
        explode: true
        schema:
          type: string
          example: '{{groupId}}'
      - name: PAPI-Use-Prefixes
        in: header
        description: (Required) Sets whether to display three-letter prefixes in various ID values in response data. This may override the client's default `usePrefixes` setting. See [ID Prefixes](doc:id-prefixes).
        required: true
        style: simple
        schema:
          type: string
          example: adipisicing anim et pariatur
      requestBody:
        description: ''
        content:
          application/json:
            schema:
              allOf:
              - $ref: '#/components/schemas/CreateanewCPcodeRequest'
              - example:
                  cpcodeName: SME WAA
                  productId: prd_Web_App_Accel
            example:
              cpcodeName: SME WAA
              productId: prd_Web_App_Accel
        required: true
      responses:
        '200':
          description: ''
          headers: {}
          content: {}
      deprecated: false
  /cpcodes/{cpcodeId}:
    get:
      tags:
      - cpcodes
      summary: GetaCPcode
      description: >
        This operation gets details about a CP code.
      operationId: GetaCPcode
      parameters:
      - name: contractId
        in: query
        description: >-
          (Required) Unique identifier for the contract.

          See [ID prefixes](doc:id-prefixes)

          for details on omitting the value's `ctr_` prefix.
        required: true
        style: form
        explode: true
        schema:
          type: string
          example: '{{contractId}}'
      - name: groupId
        in: query
        description: >-
          (Required) Unique identifier for the group.

          See [ID prefixes](doc:id-prefixes)

          for details on omitting the value's `grp_` prefix.
        required: true
        style: form
        explode: true
        schema:
          type: string
          example: '{{groupId}}'
      - name: cpcodeId
        in: path
        description: >-
          (Required) Unique identifier for the CP code.

          See [ID prefixes](doc:id-prefixes)

          for details on omitting the value's `cpc_` prefix.
        required: true
        style: simple
        schema:
          type: string
          example: '{{cpcodeId}}'
      - name: PAPI-Use-Prefixes
        in: header
        description: (Required) Sets whether to display three-letter prefixes in various ID values in response data. This may override the client's default `usePrefixes` setting. See [ID Prefixes](doc:id-prefixes).
        required: true
        style: simple
        schema:
          type: string
          example: adipisicing anim et pariatur
      responses:
        '200':
          description: ''
          headers: {}
          content: {}
      deprecated: false
  /custom-behaviors/{behaviorId}:
    delete:
      tags:
      - '{behavior Id}'
      summary: Deleteacustombehavior
      description: >
        Update status to DELETED. Operation

        is Akamai-internal.
      operationId: Deleteacustombehavior
      parameters:
      - name: behaviorId
        in: path
        description: (Required) Unique identifier for the custom behavior.
        required: true
        style: simple
        schema:
          type: string
          example: '{{behaviorId}}'
      responses:
        '200':
          description: ''
          headers: {}
          content: {}
      deprecated: false
    get:
      tags:
      - '{behavior Id}'
      summary: Getacustombehavior
      description: >
        Get information for a single custom behavior. Use this operation if you want to examine the custom behavior's XML metadata source.
      operationId: Getacustombehavior
      parameters:
      - name: behaviorId
        in: path
        description: (Required) Unique identifier for the custom behavior.
        required: true
        style: simple
        schema:
          type: string
          example: '{{behaviorId}}'
      - name: PAPI-Use-Prefixes
        in: header
        description: (Required) Sets whether to display three-letter prefixes in various ID values in response data. This may override the c