Akamai Property version rules API

openapi: 3.0.0
info:
  title: 'Akamai: API Endpoint Definition Access tokens Property version rules API'
  version: '2'
  license:
    name: Apache 2.0
    url: https://www.apache.org/licenses/LICENSE-2.0.html
servers:
- url: https://{hostname}/api-definitions/v2
tags:
- name: Property version rules
paths:
  /properties/{propertyId}/versions/{propertyVersion}/rules:
    x-akamai:
      file-path: paths/property-version-rules.yaml
      path-for-file: /properties/{propertyId}/versions/{propertyVersion}/rules
    x-akamai-descriptor-tools:
      displayName: propertyVersionRules
      group: Property version rules
    parameters:
    - description: Unique identifier for the property. See [ID prefixes](https://techdocs.akamai.com/property-mgr/reference/id-prefixes) for details on omitting the value's `prp_` prefix.
      example: '{{propertyId}}'
      in: path
      name: propertyId
      required: true
      schema:
        example: prp_12345
        type: string
      x-akamai:
        file-path: parameters/propertyId-path.yaml
    - description: Property's incremental version number.
      example: '{{propertyVersion}}'
      in: path
      name: propertyVersion
      required: true
      schema:
        example: 3
        type: integer
      x-akamai:
        file-path: parameters/propertyVersion-path.yaml
    get:
      description: Gets the entire rule tree for a property version. See the [Rule Trees](https://techdocs.akamai.com/property-mgr/reference/rule-trees) section for details on the response object's structure. Also use this operation to update from one rule format to another more recent version, incrementing the assigned set of features. See [Update rules to a newer set of features](https://techdocs.akamai.com/property-mgr/reference/rule-format-schemas#update-rules-to-a-newer-set-of-features).
      operationId: get-property-version-rules
      summary: Akamai Get a Property's Rule Tree
      tags:
      - Property version rules
      externalDocs:
        description: See documentation for this operation in Akamai's Property Manager API
        url: https://techdocs.akamai.com/property-mgr/reference/get-property-version-rules
      responses:
        '200':
          description: The response shows the rule tree for the requested property version.
          content:
            '*/*':
              example:
                accountId: act_A-CCT5678
                contractId: ctr_C-0N7RAC71
                etag: a9dfe78cf93090516bde891d009eaf57
                groupId: grp_15225
                propertyId: prp_173136
                propertyVersion: 3
                ruleFormat: v2015-08-08
                rules:
                  name: default
                  children: []
                  criteria: []
                  options:
                    is_secure: false
                  behaviors:
                  - name: origin
                    options:
                      cacheKeyHostname: ORIGIN_HOSTNAME
                      compress: true
                      enableTrueClientIp: false
                      forwardHostHeader: REQUEST_HOST_HEADER
                      hostname: origin.test.com
                      httpPort: 80
                      originType: CUSTOMER
                  - name: cpCode
                    options:
                      value:
                        id: 12345
                        name: my CP code
              schema:
                additionalProperties: false
                description: A common outer wrapping object structure. It provides additional contextual details for a set of requested data. The data itself is available under various inner members' `items` array.
                type: object
                properties:
                  accountId:
                    description: Identifies the prevailing account under which you requested the data. See [ID prefixes](https://techdocs.akamai.com/property-mgr/reference/id-prefixes) for details on how to omit the ID's `act_` prefix.
                    type: string
                  contractId:
                    description: Identifies the prevailing contract under which you requested the data. See [ID prefixes](https://techdocs.akamai.com/property-mgr/reference/id-prefixes) for details on how to omit the ID's `ctr_` prefix.
                    type: string
                  etag:
                    description: A digest with which to check the [data's integrity](https://techdocs.akamai.com/property-mgr/reference/concurrency-control).
                    type: string
                  groupId:
                    description: Identifies the prevailing group under which you requested the data. See [ID prefixes](https://techdocs.akamai.com/property-mgr/reference/id-prefixes) for details on how to omit the ID's `grp_` prefix.
                    type: string
                  propertyId:
                    description: Identifies the property a rule tree represents. See [ID prefixes](https://techdocs.akamai.com/property-mgr/reference/id-prefixes) for details on how to omit the ID's `prp_` prefix. Don't use this value if you want to exchange data with the Identity and Access Manager API. See [Manage properties and includes](https://techdocs.akamai.com/iam-api/reference/manage-access-to-properties-and-includes).
                    type: string
                  propertyVersion:
                    description: The version of the property that a rule tree represents.
                    minimum: 1
                    type: integer
                  ruleFormat:
                    description: Indicates the versioned set of features and criteria that are currently applied to a rule tree. See [API versioning](https://techdocs.akamai.com/property-mgr/reference/api-versioning) for more information.
                    type: string
                  rules:
                    additionalProperties: false
                    description: Specifies the executable logic to apply to cached edge content. The outer envelope's `rules` object specifies the relevant top-level `default` rule object. See the [Rule Trees](https://techdocs.akamai.com/property-mgr/reference/rule-trees) section for guidance on how to structure the data.
                    type: object
                    required:
                    - behaviors
                    - name
                    properties:
                      options:
                        additionalProperties: false
                        description: Flags that apply to the top-level rule object.
                        type: object
                        properties:
                          is_secure:
                            description: When enabled, serves the property's content over SSL. Doing so may enable additional rule behaviors.
                            type: boolean
                      advancedOverride:
                        description: A block of post-processing XML metadata that your Akamai representative can apply on your behalf. You need to configure this separately for each property. Use the more recent `customOverride` member to apply the same XML metadata to more than one property.
                        type: string
                      behaviors:
                        description: A series of [behavior](https://techdocs.akamai.com/property-mgr/reference/ga-behaviors) objects, which execute after the set of `criteria` evaluates. Behavior and criteria objects are structured identically. Optional on nested rules.
                        type: array
                        items:
                          additionalProperties: false
                          type: object
                          required:
                          - name
                          - options
                          properties:
                            options:
                              description: A variable set of options that configure each behavior. See the [behavior](https://techdocs.akamai.com/property-mgr/reference/ga-behaviors) and [criteria](https://techdocs.akamai.com/property-mgr/reference/ga-criteria) reference for details on each.
                              type: object
                            locked:
                              description: Indicates a behavior or criteria that you arrange with your Akamai representative to lock. Typically, you prevent further modifications to protect sensitive data from erroneous changes.
                              type: string
                            name:
                              description: The name of the behavior.
                              type: string
                            uuid:
                              description: A data hash that indicates an _advanced_ behavior. When present, you may not modify the contents of the behavior, and need to provide the same `uuid` value when modifying the rule tree. See [Advanced and locked features](https://techdocs.akamai.com/property-mgr/reference/advanced-and-locked-features).
                              type: string
                      children:
                        description: A series of nested rules that execute after the current rule's `criteria` and `behaviors`.
                        minItems: 0
                        type: array
                        items:
                          type: object
                      comment:
                        description: A descriptive comment to help you track the rule's function.
                        type: string
                      criteria:
                        description: A series of [criteria](https://techdocs.akamai.com/property-mgr/reference/ga-criteria) objects, which form a set of logical tests that may prevent the rule's `behaviors` from executing. Behavior and criteria objects are structured identically.
                        type: array
                        items:
                          type: object
                      criteriaLocked:
                        description: Within child rules, this prohibits any modifications to `criteria` objects. Contact your Akamai representative to change the value.
                        type: boolean
                      customOverride:
                        additionalProperties: false
                        description: Specifies post-processing XML metadata that your Akamai representative can create on your behalf. Once available with the [List custom overrides](https://techdocs.akamai.com/property-mgr/reference/get-custom-overrides) operation, you can assign an `overrideId` to more than one property's `default` rule. See [Custom behaviors and overrides](https://techdocs.akamai.com/property-mgr/reference/custom-behaviors-and-overrides) for guidance.
                        type: object
                        required:
                        - name
                        - overrideId
                        properties:
                          name:
                            description: The name of the custom override. It may vary from what appears in the [List custom overrides](https://techdocs.akamai.com/property-mgr/reference/get-custom-overrides) operation's response object.
                            type: string
                          overrideId:
                            description: Identifies the predefined custom override metadata you want to append to the current rule. See [ID prefixes](https://techdocs.akamai.com/property-mgr/reference/id-prefixes) for details on how to omit the ID's `cbo_` prefix.
                            type: string
                      name:
                        description: A description of the rule. The top-level rule needs to be named `default`.
                        type: string
                      uuid:
                        description: A data hash that indicates the rule contains at least one _advanced_ behavior or criteria, each identified with its own `uuid` member. When this member is present on the rule, you may not remove any advanced features it contains, or change their sequence. You need to provide the same `uuid` value when modifying the rule tree. See [Advanced and locked features](https://techdocs.akamai.com/property-mgr/reference/advanced-and-locked-features).
                        type: string
                      variables:
                        description: Declares a variable. See [Variables](https://techdocs.akamai.com/property-mgr/reference/variables) for guidance on how variables may appear within a rule tree.
                        minItems: 0
                        type: array
                        items:
                          additionalProperties: false
                          type: object
                          required:
                          - hidden
                          - name
                          - sensitive
                          properties:
                            description:
                              description: Text for you to keep track of how you use each variable.
                              type: string
                            hidden:
                              description: When enabled, the variable is suppressed from session response headers. Useful when testing content as described in the [Debug variables](https://techdocs.akamai.com/property-mgr/reference/debug-variables) section.
                              type: boolean
                            name:
                              description: The underlying root name of the variable, which needs to be unique within the set of `variables`.
                              type: string
                            sensitive:
                              description: When enabled, the variable is suppressed from session responses as `hidden` ones, but it also can't be invoked within any behaviors that assign values to cookies or response headers. You also can't assign a `sensitive` variable to another one that isn't `sensitive`, and you can't add it to custom logging fields. Use this more stringent option for any personally identifiable information, typically after initially testing on the staging network.
                              type: boolean
                            value:
                              description: Initializes a default value. Omitting this member initializes the variable with an empty string.
                              type: string
                x-akamai:
                  file-path: schemas/property-version-rules-get-response.yaml
          headers:
            ETag:
              description: Pass the `ETag` response header back as `If-Match` in write requests to ensure you don't overwrite edits by any other API clients. See [Concurrency control](https://techdocs.akamai.com/property-mgr/reference/concurrency-control) for details.
              example: '"a9dfe78cf93090516bde891d009eaf57"'
              schema:
                type: string
              x-akamai:
                file-path: headers/Etag.yaml
            X-Limit-Clientip-Per-Property-Limit:
              description: Maximum number of separate [Client IP](https://techdocs.akamai.com/property-mgr/reference/latest-client-ip) matches per property rule tree configuration.
              schema:
                type: string
              x-akamai:
                file-path: headers/X-Limit-Clientip-Per-Property-Limit.yaml
            X-Limit-Clientip-Per-Property-Remaining:
              description: Remaining number of separate [Client IP](https://techdocs.akamai.com/property-mgr/reference/latest-client-ip) matches per property rule tree configuration. See [Rate and resource limiting](https://techdocs.akamai.com/property-mgr/reference/rate-and-resource-limiting) for details.
              schema:
                type: string
              x-akamai:
                file-path: headers/X-Limit-Clientip-Per-Property-Remaining.yaml
            X-Limit-Elements-Per-Property-Limit:
              description: Maximum number of separate matches and behaviors per property rule tree configuration. See [Rate and resource limiting](https://techdocs.akamai.com/property-mgr/reference/rate-and-resource-limiting) for details.
              schema:
                type: string
              x-akamai:
                file-path: headers/X-Limit-Elements-Per-Property-Limit.yaml
            X-Limit-Elements-Per-Property-Remaining:
              description: Remaining number of separate matches and behaviors per property rule tree configuration. See [Rate and resource limiting](https://techdocs.akamai.com/property-mgr/reference/rate-and-resource-limiting) for details.
              schema:
                type: string
              x-akamai:
                file-path: headers/X-Limit-Elements-Per-Property-Remaining.yaml
            X-Limit-Max-Clientip-Per-Match-Limit:
              description: Maximum number of separate IP addresses allowed within each [Client IP](https://techdocs.akamai.com/property-mgr/reference/latest-client-ip) match.
              schema:
                type: string
              x-akamai:
                file-path: headers/X-Limit-Max-Clientip-Per-Match-Limit.yaml
            X-Limit-Max-Clientip-Per-Match-Remaining:
              description: Remaining number of separate IP addresses allowed within each [Client IP](https://techdocs.akamai.com/property-mgr/reference/latest-client-ip) match. See [Rate and resource limiting](https://techdocs.akamai.com/property-mgr/reference/rate-and-resource-limiting) for details.
              schema:
                type: string
              x-akamai:
                file-path: headers/X-Limit-Max-Clientip-Per-Match-Remaining.yaml
            X-Limit-Max-Nested-Rules-Limit:
              description: Maximum number of nested child rules in a property to apply conditional logic.
              schema:
                type: string
              x-akamai:
                file-path: headers/X-Limit-Max-Nested-Rules-Limit.yaml
            X-Limit-Max-Nested-Rules-Remaining:
              description: Remaining number of nested child rules in a property to apply conditional logic. See [Rate and resource limiting](https://techdocs.akamai.com/property-mgr/reference/rate-and-resource-limiting) for details.
              schema:
                type: string
              x-akamai:
                file-path: headers/X-Limit-Max-Nested-Rules-Remaining.yaml
        '400':
          description: '[Bad request](https://techdocs.akamai.com/property-mgr/reference/400).'
          content:
            application/problem+json:
              example:
                detail: The system cannot understand your request.  Please check the syntax and correct any problems.
                instance: /papi/v1/properties?contractId=ctr_C-0N7RAC7&groupId=grp_12345#abc12345abcc02a7
                status: 400
                title: Bad Request
                type: https://problems.luna.akamaiapis.net/papi/v0/http/bad-request
              schema:
                additionalProperties: false
                description: Represents error data in the [RFC 7807](https://www.rfc-editor.org/rfc/rfc7807) Problem Details format.
                type: object
                required:
                - type
                - title
                - status
                - detail
                - instance
                properties:
                  detail:
                    description: Diagnostic instructions to locate and fix the problem.
                    minLength: 1
                    type: string
                  errors:
                    description: For errors with more than one detected problem, this represents each as a nested Problem Details object.
                    minItems: 0
                    type: array
                    uniqueItems: true
                    items:
                      additionalProperties: false
                      description: Represents error data in the [RFC 7807](https://www.rfc-editor.org/rfc/rfc7807) Problem Details format.
                      type: object
                      required:
                      - type
                      - title
                      - detail
                      properties:
                        detail:
                          description: Diagnostic instructions to locate and fix the problem.
                          minLength: 1
                          type: string
                        instance:
                          description: Unique value generated with each API call.
                          minLength: 1
                          type: string
                        status:
                          description: The HTTP status code that categorizes this error case.
                          maximum: 600
                          minimum: 100
                          type: integer
                        title:
                          description: A summary of each error case.
                          minLength: 1
                          type: string
                        type:
                          description: Identifies each error case.
                          format: uri
                          type: string
                      x-akamai:
                        file-path: schemas/problem-nested.yaml
                  instance:
                    description: Unique value generated with each API call.
                    minLength: 1
                    type: string
                  status:
                    description: The HTTP status code that categorizes this error case.
                    maximum: 600
                    minimum: 100
                    type: integer
                  title:
                    description: A summary of each error case.
                    minLength: 1
                    type: string
                  type:
                    description: Identifies each error case.
                    format: uri
                    type: string
                x-akamai:
                  file-path: schemas/problem.yaml
          x-akamai:
            file-path: errors/400.yaml
        '401':
          description: '[Unauthorized](https://techdocs.akamai.com/property-mgr/reference/401).'
          content:
            application/problem+json:
              example:
                detail: The request requires authentication.
                instance: /papi/v1/properties?contractId=ctr_C-0N7RAC7&groupId=grp_12345#abc12345abcc02a7
                status: 401
                title: Unauthorized
                type: https://problems.luna.akamaiapis.net/papi/v0/http/unauthorized
              schema:
                additionalProperties: false
                description: Represents error data in the [RFC 7807](https://www.rfc-editor.org/rfc/rfc7807) Problem Details format.
                type: object
                required:
                - type
                - title
                - status
                - detail
                - instance
                properties:
                  detail:
                    description: Diagnostic instructions to locate and fix the problem.
                    minLength: 1
                    type: string
                  errors:
                    description: For errors with more than one detected problem, this represents each as a nested Problem Details object.
                    minItems: 0
                    type: array
                    uniqueItems: true
                    items:
                      additionalProperties: false
                      description: Represents error data in the [RFC 7807](https://www.rfc-editor.org/rfc/rfc7807) Problem Details format.
                      type: object
                      required:
                      - type
                      - title
                      - detail
                      properties:
                        detail:
                          description: Diagnostic instructions to locate and fix the problem.
                          minLength: 1
                          type: string
                        instance:
                          description: Unique value generated with each API call.
                          minLength: 1
                          type: string
                        status:
                          description: The HTTP status code that categorizes this error case.
                          maximum: 600
                          minimum: 100
                          type: integer
                        title:
                          description: A summary of each error case.
                          minLength: 1
                          type: string
                        type:
                          description: Identifies each error case.
                          format: uri
                          type: string
                      x-akamai:
                        file-path: schemas/problem-nested.yaml
                  instance:
                    description: Unique value generated with each API call.
                    minLength: 1
                    type: string
                  status:
                    description: The HTTP status code that categorizes this error case.
                    maximum: 600
                    minimum: 100
                    type: integer
                  title:
                    description: A summary of each error case.
                    minLength: 1
                    type: string
                  type:
                    description: Identifies each error case.
                    format: uri
                    type: string
                x-akamai:
                  file-path: schemas/problem.yaml
          x-akamai:
            file-path: errors/401.yaml
        '403':
          description: '[Forbidden](https://techdocs.akamai.com/property-mgr/reference/403).'
          content:
            application/problem+json:
              example:
                detail: The authorization token you provided does not allow access to this resource.
                instance: /papi/v1/properties?contractId=ctr_C-0N7RAC7&groupId=grp_12345#abc12345abcc02a7
                status: 403
                title: Forbidden
                type: https://problems.luna.akamaiapis.net/papi/v1/http/forbidden
              schema:
                additionalProperties: false
                description: Represents error data in the [RFC 7807](https://www.rfc-editor.org/rfc/rfc7807) Problem Details format.
                type: object
                required:
                - type
                - title
                - status
                - detail
                - instance
                properties:
                  detail:
                    description: Diagnostic instructions to locate and fix the problem.
                    minLength: 1
                    type: string
                  errors:
                    description: For errors with more than one detected problem, this represents each as a nested Problem Details object.
                    minItems: 0
                    type: array
                    uniqueItems: true
                    items:
                      additionalProperties: false
                      description: Represents error data in the [RFC 7807](https://www.rfc-editor.org/rfc/rfc7807) Problem Details format.
                      type: object
                      required:
                      - type
                      - title
                      - detail
                      properties:
                        detail:
                          description: Diagnostic instructions to locate and fix the problem.
                          minLength: 1
                          type: string
                        instance:
                          description: Unique value generated with each API call.
                          minLength: 1
                          type: string
                        status:
                          description: The HTTP status code that categorizes this error case.
                          maximum: 600
                          minimum: 100
                          type: integer
                        title:
                          description: A summary of each error case.
                          minLength: 1
                          type: string
                        type:
                          description: Identifies each error case.
                          format: uri
                          type: string
                      x-akamai:
                        file-path: schemas/problem-nested.yaml
                  instance:
                    description: Unique value generated with each API call.
                    minLength: 1
                    type: string
                  status:
                    description: The HTTP status code that categorizes this error case.
                    maximum: 600
                    minimum: 100
                    type: integer
                  title:
                    description: A summary of each error case.
                    minLength: 1
                    type: string
                  type:
                    description: Identifies each error case.
                    format: uri
                    type: string
                x-akamai:
                  file-path: schemas/problem.yaml
          x-akamai:
            file-path: errors/403.yaml
        '404':
          description: '[Not found](https://techdocs.akamai.com/property-mgr/reference/404).'
          content:
            application/problem+json:
              example:
                detail: The system was unable to locate the requested resource.
                instance: /papi/v1/properties?contractId=ctr_C-0N7RAC7&groupId=grp_12345#abc12345abcc02a7
                status: 404
                title: Not Found
                type: https://problems.luna.akamaiapis.net/papi/v1/http/not-found
              schema:
                additionalProperties: false
                description: Represents error data in the [RFC 7807](https://www.rfc-editor.org/rfc/rfc7807) Problem Details format.
                type: object
                required:
                - type
                - title
                - status
                - detail
                - instance
                properties:
                  detail:
                    description: Diagnostic instructions to locate and fix the problem.
                    minLength: 1
                    type: string
                  errors:
                    description: For errors with more than one detected problem, this represents each as a nested Problem Details object.
                    minItems: 0
                    type: array
                    uniqueItems: true
                    items:
                      additionalProperties: false
                      description: Represents error data in the [RFC 7807](https://www.rfc-editor.org/rfc/rfc7807) Problem Details format.
                      type: object
                      required:
                      - type
                      - title
                      - detail
                      properties:
                        detail:
                          description: Diagnostic instructions to locate and fix the problem.
                          minLength: 1
                          type: string
                        instance:
                          description: Unique value generated with each API call.
                          minLength: 1
                          type: string
                        status:
                          description: The HTTP status code that categorizes this error case.
                          maximum: 600
                          minimum: 100
                          type: integer
                        title:
                          description: A summary of each error case.
                          minLength: 1
                          type: string
                        type:
                          description: Identifies each error case.
                          format: uri
                          type: string
                      x-akamai:
                        file-path: schemas/problem-nested.yaml
                  instance:
                    description: Unique value generated with each API call.
                    minLength: 1
                    type: string
                  status:
                    description: The HTTP status code that categorizes this error case.
                    maximum:

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