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: 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/404.yaml '405': description: '[Method not allowed](https://techdocs.akamai.com/property-mgr/reference/405).' content: application/problem+json: example: detail: The system does not support the method you provided for this resource. instance: /papi/v1/properties?contractId=ctr_C-0N7RAC7&groupId=grp_12345#abc12345abcc02a7 status: 405 title: Method not allowed type: https://problems.luna.akamaiapis.net/papi/v1/http/method-not-allowed 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/405.yaml '406': description: '[Not acceptable](https://techdocs.akamai.com/property-mgr/reference/406).' content: application/problem+json: example: detail: The system does not support the content-type restrictions provided by your 'Accept' header. instance: papi/v1/build#abc12345abcc02a7 status: 406 title: Not Acceptable type: https://problems.luna.akamaiapis.net/papi/v1/http/not-acceptable 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/406.yaml '429': description: '[Too many requests](https://techdocs.akamai.com/property-mgr/reference/429).' content: application/problem+json: example: detail: Too many includes exist on contract ctr_1-12345. You must delete an include before continuing. instance: /papi/v1/includes?contractId=ctr_C-0N7RAC7&groupId=grp_12345#abc12345abcc02a7 instanceKey: 1-12345 limit: 500 limitKey: INCLUDES_PER_CONTRACT remaining: 0 status: 429 title: Too many includes type: https://problems.luna.akamaiapis.net/papi/v1/limit-exceeded 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 - limitKey - instanceKey - limit - remaining 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 instanceKey: description: Identifies the resource the limit is imposed on. minLength: 1 type: string limit: description: The overall limit. type: integer limitKey: description: The limit that got exceeded with the operation. minLength: 1 type: string remaining: description: Number of items left to deploy. type: integer 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-429.yaml x-akamai: file-path: errors/429.yaml '500': description: '[Internal server error](https://techdocs.akamai.com/property-mgr/reference/500).' content: application/problem+json: example: detail: Our system is experiencing errors. We''ll get this fixed as soon as possible. instance: /papi/v1/properties/12345/activations#abc12345abcc02a7 status: 500 title: Internal Server Error type: https://problems.luna.akamaiapis.net/papi/proxy/internal-server-error 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/500.yaml parameters: - description: __Enum__ Sets whether to represent [ID prefixes](https://techdocs.akamai.com/property-mgr/reference/id-prefixes) in response data. Set to `false` when exchanging PAPI data with other APIs. example: '{{PAPI-Use-Prefixes}}' in: header name: PAPI-Use-Prefixes required: true schema: example: 'false' type: string enum: - 'true' - 'false' x-akamai: file-path: parameters/PAPI-Use-Prefixes-header.yaml - description: Unique identifier for the contract. The parameter is optional if a property belongs to 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](https://techdocs.akamai.com/property-mgr/reference/id-prefixes) for details on omitting the value's `ctr_` prefix. example: '{{contractId}}' in: query name: contractId required: false schema: example: ctr_1-1TJZFW type: string x-akamai: file-path: parameters/contractId-optional.yaml - description: Unique identifier for the group. The parameter is optional if a property belongs to 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](https://techdocs.akamai.com/property-mgr/reference/id-prefixes) for details on omitting the value's `grp_` prefix. example: '{{groupId}}' in: query name: groupId required: false schema: example: grp_15166 type: string x-akamai: file-path: parameters/groupId-optional.yaml - description: Set to `true` by default. When `false`, skips validation tests that would identify potential problems within the response object's `errors` and `warnings` arrays. See [Rule tree errors and warnings](https://techdocs.akamai.com/property-mgr/reference/rule-tree-errors-and-warnings) and [Validation errors](https://techdocs.akamai.com/property-mgr/reference/validation-errors) for information on how validation data appears in the response object. See [Validation best practices](https://techdocs.akamai.com/property-mgr/reference/validation-best-practices) for guidance on when to defer validation. example: '{{validateRules}}' in: query name: validateRules required: false schema: default: true example: true type: boolean x-akamai: file-path: parameters/validateRules-query.yaml - description: __Enum__ With `validateRules` enabled, setting this to `fast` performs a quick validation check based on the provided JSON. This is faster than the default `full` validation, which performs more extensive checks on the converted XML metadata configuration. See [Validation best practices](https://techdocs.akamai.com/property-mgr/reference/validation-best-practices) for more guidance. example: '{{validateMode}}' in: query name: validateMode required: false schema: default: full example: fast type: string enum: - full - fast x-akamai: file-path: parameters/validateMode-query.yaml - description: For customers who manage more than one account, this [runs the operation from another account](https://techdocs.akamai.com/developer/docs/manage-many-accounts-with-one-api-client). The Identity and Access Management API provides a [list of available account switch keys](https://techdocs.akamai.com/iam-api/reference/get-client-account-switch-keys). example: '{{accountSwitchKey}}' in: query name: accountSwitchKey required: false schema: example: 1-5C0YLB:1-8BYUX type: string put: description: To write a rule tree to a property version, make a PUT request to the same resource as the GET request that reads it. Pass in the rule object in the body of the request. See the [Rule Trees](https://techdocs.akamai.com/property-mgr/reference/rule-trees) section for details on the rule tree's structure. Use this operation also to [freeze a set of rules](https://techdocs.akamai.com/property-mgr/reference/rule-format-schemas#freeze-a-feature-set-for-a-rule-tree) to a rule format version to ensure no change in a deployed activation's behavior. Set the `validateRules` query parameter to `false` to bypass a set of validation tests that may significantly slow this operation's execution time. See [Validation best practices](https://techdocs.akamai.com/property-mgr/reference/validation-best-practices) for guidance on when to defer validation. See [Rule tree errors and warnings](https://techdocs.akamai.com/property-mgr/reference/rule-tree-errors-and-warnings) and [Validation errors](https://techdocs.akamai.com/property-mgr/reference/validation-errors) for information on how validation data is embedded within the response object. operationId: put-property-version-rules summary: Akamai Update 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/put-property-version-rules requestBody: required: true content: '*/*': example: 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: $schema: http://json-schema.org/draft-04-schema# description: Specifies the executable logic to apply to cached edge content. id: resource:/descriptors/papi/v1/schemas/property-version-rules-set-request.json# javaType: com.fasterxml.jackson.databind.JsonNode type: object properties: rules: description: Specifies the executable logic to apply to cached edge content. A common outer wrapping `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: - name - behaviors properties: options: 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: type: object required: - name - options properties: options: description: A variable set of options that configure each behavior. See the [PAPI Feature Catalog Reference](https://techdocs.akamai.com/property-mgr/reference/ga-behaviors) 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). readOnly: true type: string children: description: A series of nested rules that execute after the current rule's `criteria` and `behaviors`. type: array items: description: A series of nested rules that execute after the current rule's `criteria` and `behaviors`. 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: 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: object criteriaLocked: description: Within child rules, this prohibits any modifications to `criteria` objects. Contact your Akamai representative to change the value. readOnly: true type: boolean customOverride: 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: - overrideId - name 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. type: array items: type: object required: - name - hidden - 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-set-request.yaml application/json: example: 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: $schema: http://json-schema.org/draft-04-schema# description: Specifies the executable logic to apply to cached edge content. id: resource:/descriptors/papi/v1/schemas/property-version-rules-set-request.json# javaType: com.fasterxml.jackson.databind.JsonNode type: object properties: rules: description: Specifies the executable logic to apply to cached edge content. A common outer wrapping `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: - name - behaviors properties: options: 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: type: object required: - name - options properties: options: description: A variable set of options that configure each behavior. See the [PAPI Feature Catalog Reference](https://techdocs.akamai.com/property-mgr/reference/ga-behaviors) 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). readOnly: true type: string children: description: A series of nested rules that execute after the current rule's `criteria` and `behaviors`. type: array items: description: A series of nested rules that execute after the current rule's `criteria` and `behaviors`. 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: 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: object criteriaLocked: description: Within child rules, this prohibits any modifications to `criteria` objects. Contact your Akamai representative to change the value. readOnly: true type: boolean customOverride: 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: - overrideId - name 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. type: array items: type: object required: - name - hidden - 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-set-request.yaml responses: '200': description: The response shows updated rule tree for the specified property version. content: '*/*': example: accountId: act_A-CCT9012 contractId: ctr_K-0N7RAK71 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: 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/404.yaml '405': description: '[Method not allowed](https://techdocs.akamai.com/property-mgr/reference/405).' content: application/problem+json: example: detail: The system does not support the method you provided for this resource. instance: /papi/v1/properties?contractId=ctr_C-0N7RAC7&groupId=grp_12345#abc12345abcc02a7 status: 405 title: Method not allowed type: https://problems.luna.akamaiapis.net/papi/v1/http/method-not-allowed 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/405.yaml '406': description: '[Not acceptable](https://techdocs.akamai.com/property-mgr/reference/406).' content: application/problem+json: example: detail: The system does not support the content-type restrictions provided by your 'Accept' header. instance: papi/v1/build#abc12345abcc02a7 status: 406 title: Not Acceptable type: https://problems.luna.akamaiapis.net/papi/v1/http/not-acceptable 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/406.yaml '412': description: '[Precondition failed](https://techdocs.akamai.com/property-mgr/reference/412).' content: application/problem+json: example: detail: Cannot activate the property at this time, please try again. instance: papi/v1/properties/prp_123456/activations?contractId=ctr_C-0N7RAC7&groupId=grp_12345#abc12345abcc02a7 status: 412 title: Precondition Failed type: https://problems.luna.akamaiapis.net/papi/v0/toolkit/validation_failed.error.activation.tower_precondition.failed 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/412.yaml '415': description: '[Unsupported media type](https://techdocs.akamai.com/property-mgr/reference/415).' content: application/problem+json: example: detail: Our system does not support requests in the format you're sending. instance: /papi/v1/properties?contractId=ctr_C-0N7RAC7&groupId=grp_12345#abc12345abcc02a7 status: 415 title: Unsupported Media Type type: https://problems.luna.akamaiapis.net/papi/v1/http/unsupported-media-type 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/415.yaml '429': description: '[Too many requests](https://techdocs.akamai.com/property-mgr/reference/429).' content: application/problem+json: example: detail: Too many includes exist on contract ctr_1-12345. You must delete an include before continuing. instance: /papi/v1/includes?contractId=ctr_C-0N7RAC7&groupId=grp_12345#abc12345abcc02a7 instanceKey: 1-12345 limit: 500 limitKey: INCLUDES_PER_CONTRACT remaining: 0 status: 429 title: Too many includes type: https://problems.luna.akamaiapis.net/papi/v1/limit-exceeded 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 - limitKey - instanceKey - limit - remaining 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 instanceKey: description: Identifies the resource the limit is imposed on. minLength: 1 type: string limit: description: The overall limit. type: integer limitKey: description: The limit that got exceeded with the operation. minLength: 1 type: string remaining: description: Number of items left to deploy. type: integer 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-429.yaml x-akamai: file-path: errors/429.yaml '500': description: '[Internal server error](https://techdocs.akamai.com/property-mgr/reference/500).' content: application/problem+json: example: detail: Our system is experiencing errors. We''ll get this fixed as soon as possible. instance: /papi/v1/properties/12345/activations#abc12345abcc02a7 status: 500 title: Internal Server Error type: https://problems.luna.akamaiapis.net/papi/proxy/internal-server-error 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/500.yaml parameters: - description: This corresponds to the `ETag` response header. Passing this value back as `If-Match` in write requests ensures 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: '{{If-Match}}' in: header name: If-Match required: true schema: example: '"a9dfe78cf93090516bde891d009eaf57"' type: string x-akamai: file-path: parameters/If-Match-header.yaml - description: __Enum__ Sets whether to represent [ID prefixes](https://techdocs.akamai.com/property-mgr/reference/id-prefixes) in response data. Set to `false` when exchanging PAPI data with other APIs. example: '{{PAPI-Use-Prefixes}}' in: header name: PAPI-Use-Prefixes required: true schema: example: 'false' type: string enum: - 'true' - 'false' x-akamai: file-path: parameters/PAPI-Use-Prefixes-header.yaml - description: Unique identifier for the contract. The parameter is optional if a property belongs to 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](https://techdocs.akamai.com/property-mgr/reference/id-prefixes) for details on omitting the value's `ctr_` prefix. example: '{{contractId}}' in: query name: contractId required: false schema: example: ctr_1-1TJZFW type: string x-akamai: file-path: parameters/contractId-optional.yaml - description: Unique identifier for the group. The parameter is optional if a property belongs to 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](https://techdocs.akamai.com/property-mgr/reference/id-prefixes) for details on omitting the value's `grp_` prefix. example: '{{groupId}}' in: query name: groupId required: false schema: example: grp_15166 type: string x-akamai: file-path: parameters/groupId-optional.yaml - description: Set to `true` by default. When `false`, skips validation tests that would identify potential problems within the response object's `errors` and `warnings` arrays. See [Rule tree errors and warnings](https://techdocs.akamai.com/property-mgr/reference/rule-tree-errors-and-warnings) and [Validation errors](https://techdocs.akamai.com/property-mgr/reference/validation-errors) for information on how validation data appears in the response object. See [Validation best practices](https://techdocs.akamai.com/property-mgr/reference/validation-best-practices) for guidance on when to defer validation. example: '{{validateRules}}' in: query name: validateRules required: false schema: default: true example: true type: boolean x-akamai: file-path: parameters/validateRules-query.yaml - description: __Enum__ With `validateRules` enabled, setting this to `fast` performs a quick validation check based on the provided JSON. This is faster than the default `full` validation, which performs more extensive checks on the converted XML metadata configuration. See [Validation best practices](https://techdocs.akamai.com/property-mgr/reference/validation-best-practices) for more guidance. example: '{{validateMode}}' in: query name: validateMode required: false schema: default: full example: fast type: string enum: - full - fast x-akamai: file-path: parameters/validateMode-query.yaml - description: With the `validateRules` query parameter also enabled, allows for a _dry run_ in order to gather any possible errors without saving the rule tree. See [Validation best practices](https://techdocs.akamai.com/property-mgr/reference/validation-best-practices) for more guidance. example: '{{dryRun}}' in: query name: dryRun required: false schema: default: false example: true type: boolean x-akamai: file-path: parameters/dryRun-query.yaml - description: For customers who manage more than one account, this [runs the operation from another account](https://techdocs.akamai.com/developer/docs/manage-many-accounts-with-one-api-client). The Identity and Access Management API provides a [list of available account switch keys](https://techdocs.akamai.com/iam-api/reference/get-client-account-switch-keys). example: '{{accountSwitchKey}}' in: query name: accountSwitchKey required: false schema: example: 1-5C0YLB:1-8BYUX type: string patch: description: Selectively modify a rule tree using [JSON patch](http://jsonpatch.com) syntax. As a component of the larger [Bulk patch a set of properties](https://techdocs.akamai.com/property-mgr/reference/post-bulk-patch), this operation patches an individual rule tree. See [Bulk Search and Update](https://techdocs.akamai.com/property-mgr/reference/bulk-search-and-update) for more information. To bypass a set of validation tests that may significantly slow this operation's execution time, set the `validateRules` query parameter to `false` or `validateMode` to `fast`. See [Validation best practices](https://techdocs.akamai.com/property-mgr/reference/validation-best-practices) for guidance on when to defer validation. See [Rule tree errors and warnings](https://techdocs.akamai.com/property-mgr/reference/rule-tree-errors-and-warnings) and [Validation errors](https://techdocs.akamai.com/property-mgr/reference/validation-errors) for information on how validation data is embedded within the response object. operationId: patch-property-version-rules summary: Akamai Patch 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/patch-property-version-rules requestBody: required: true content: application/json-patch+json: schema: $schema: http://json-schema.org/draft-04/schema# description: The series of JSON Patch operations. id: resource:/descriptors/papi/v1/schemas/property-version-rules-patch-request.json# javaType: com.fasterxml.jackson.databind.JsonNode type: array items: type: object required: - op - path x-akamai: file-path: schemas/operation.yaml allOf: - type: object properties: path: description: A JSON Pointer path. type: string x-akamai: file-path: schemas/path.yaml oneOf: - title: Replace, add, test required: - value properties: op: description: 'The operation to perform: `replace`, `add`, or `test` in this case.' type: string enum: - replace - test - add value: description: The value to replace, test, or add. Specify any data type. oneOf: - title: String type: string - title: Numeric type: number - title: Boolean type: boolean - title: Object type: object - title: Array type: array items: anyOf: - title: String type: string - title: Numeric type: number - title: Boolean type: boolean - title: Object type: object - title: Remove properties: op: description: 'The operation to perform: `remove` in this case.' type: string enum: - remove - title: Move, copy required: - from properties: from: description: A JSON Pointer path pointing to the location to move or copy from. type: string op: description: 'The operation to perform: `move` or `copy` in this case.' type: string enum: - move - copy x-akamai: file-path: schemas/property-version-rules-patch-request.yaml example: - op: replace path: /rules/options/is_secure value: true - op: replace path: /rules/children/0/name value: Handle /my-path responses: '200': description: The response shows modified rule tree for the specified property version. content: '*/*': example: accountId: act_A-CCT5678 contractId: ctr_K-0N7RAK7 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: 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/404.yaml '405': description: '[Method not allowed](https://techdocs.akamai.com/property-mgr/reference/405).' content: application/problem+json: example: detail: The system does not support the method you provided for this resource. instance: /papi/v1/properties?contractId=ctr_C-0N7RAC7&groupId=grp_12345#abc12345abcc02a7 status: 405 title: Method not allowed type: https://problems.luna.akamaiapis.net/papi/v1/http/method-not-allowed 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/405.yaml '406': description: '[Not acceptable](https://techdocs.akamai.com/property-mgr/reference/406).' content: application/problem+json: example: detail: The system does not support the content-type restrictions provided by your 'Accept' header. instance: papi/v1/build#abc12345abcc02a7 status: 406 title: Not Acceptable type: https://problems.luna.akamaiapis.net/papi/v1/http/not-acceptable 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/406.yaml '412': description: '[Precondition failed](https://techdocs.akamai.com/property-mgr/reference/412).' content: application/problem+json: example: detail: Cannot activate the property at this time, please try again. instance: papi/v1/properties/prp_123456/activations?contractId=ctr_C-0N7RAC7&groupId=grp_12345#abc12345abcc02a7 status: 412 title: Precondition Failed type: https://problems.luna.akamaiapis.net/papi/v0/toolkit/validation_failed.error.activation.tower_precondition.failed 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/412.yaml '415': description: '[Unsupported media type](https://techdocs.akamai.com/property-mgr/reference/415).' content: application/problem+json: example: detail: Our system does not support requests in the format you're sending. instance: /papi/v1/properties?contractId=ctr_C-0N7RAC7&groupId=grp_12345#abc12345abcc02a7 status: 415 title: Unsupported Media Type type: https://problems.luna.akamaiapis.net/papi/v1/http/unsupported-media-type 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/415.yaml '429': description: '[Too many requests](https://techdocs.akamai.com/property-mgr/reference/429).' content: application/problem+json: example: detail: Too many includes exist on contract ctr_1-12345. You must delete an include before continuing. instance: /papi/v1/includes?contractId=ctr_C-0N7RAC7&groupId=grp_12345#abc12345abcc02a7 instanceKey: 1-12345 limit: 500 limitKey: INCLUDES_PER_CONTRACT remaining: 0 status: 429 title: Too many includes type: https://problems.luna.akamaiapis.net/papi/v1/limit-exceeded 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 - limitKey - instanceKey - limit - remaining 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 instanceKey: description: Identifies the resource the limit is imposed on. minLength: 1 type: string limit: description: The overall limit. type: integer limitKey: description: The limit that got exceeded with the operation. minLength: 1 type: string remaining: description: Number of items left to deploy. type: integer 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-429.yaml x-akamai: file-path: errors/429.yaml '500': description: '[Internal server error](https://techdocs.akamai.com/property-mgr/reference/500).' content: application/problem+json: example: detail: Our system is experiencing errors. We''ll get this fixed as soon as possible. instance: /papi/v1/properties/12345/activations#abc12345abcc02a7 status: 500 title: Internal Server Error type: https://problems.luna.akamaiapis.net/papi/proxy/internal-server-error 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/500.yaml parameters: - description: This corresponds to the `ETag` response header. Passing this value back as `If-Match` in write requests ensures 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: '{{If-Match}}' in: header name: If-Match required: true schema: example: '"a9dfe78cf93090516bde891d009eaf57"' type: string x-akamai: file-path: parameters/If-Match-header.yaml - description: __Enum__ Sets whether to represent [ID prefixes](https://techdocs.akamai.com/property-mgr/reference/id-prefixes) in response data. Set to `false` when exchanging PAPI data with other APIs. example: '{{PAPI-Use-Prefixes}}' in: header name: PAPI-Use-Prefixes required: true schema: example: 'false' type: string enum: - 'true' - 'false' x-akamai: file-path: parameters/PAPI-Use-Prefixes-header.yaml - description: Unique identifier for the contract. The parameter is optional if a property belongs to 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](https://techdocs.akamai.com/property-mgr/reference/id-prefixes) for details on omitting the value's `ctr_` prefix. example: '{{contractId}}' in: query name: contractId required: false schema: example: ctr_1-1TJZFW type: string x-akamai: file-path: parameters/contractId-optional.yaml - description: Unique identifier for the group. The parameter is optional if a property belongs to 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](https://techdocs.akamai.com/property-mgr/reference/id-prefixes) for details on omitting the value's `grp_` prefix. example: '{{groupId}}' in: query name: groupId required: false schema: example: grp_15166 type: string x-akamai: file-path: parameters/groupId-optional.yaml - description: Set to `true` by default. When `false`, skips validation tests that would identify potential problems within the response object's `errors` and `warnings` arrays. See [Rule tree errors and warnings](https://techdocs.akamai.com/property-mgr/reference/rule-tree-errors-and-warnings) and [Validation errors](https://techdocs.akamai.com/property-mgr/reference/validation-errors) for information on how validation data appears in the response object. See [Validation best practices](https://techdocs.akamai.com/property-mgr/reference/validation-best-practices) for guidance on when to defer validation. example: '{{validateRules}}' in: query name: validateRules required: false schema: default: true example: true type: boolean x-akamai: file-path: parameters/validateRules-query.yaml - description: __Enum__ With `validateRules` enabled, setting this to `fast` performs a quick validation check based on the provided JSON. This is faster than the default `full` validation, which performs more extensive checks on the converted XML metadata configuration. See [Validation best practices](https://techdocs.akamai.com/property-mgr/reference/validation-best-practices) for more guidance. example: '{{validateMode}}' in: query name: validateMode required: false schema: default: full example: fast type: string enum: - full - fast x-akamai: file-path: parameters/validateMode-query.yaml - description: With the `validateRules` query parameter also enabled, allows for a _dry run_ in order to gather any possible errors without saving the rule tree. See [Validation best practices](https://techdocs.akamai.com/property-mgr/reference/validation-best-practices) for more guidance. example: '{{dryRun}}' in: query name: dryRun required: false schema: default: false example: true type: boolean x-akamai: file-path: parameters/dryRun-query.yaml - description: For customers who manage more than one account, this [runs the operation from another account](https://techdocs.akamai.com/developer/docs/manage-many-accounts-with-one-api-client). The Identity and Access Management API provides a [list of available account switch keys](https://techdocs.akamai.com/iam-api/reference/get-client-account-switch-keys). example: '{{accountSwitchKey}}' in: query name: accountSwitchKey required: false schema: example: 1-5C0YLB:1-8BYUX type: string head: description: Gets the rule tree's ETag without the rule tree object. Ordinarily when you [get a rule tree](https://techdocs.akamai.com/property-mgr/reference/get-property-version-rules), the response includes a large rule tree object. As discussed in [Concurrency control](https://techdocs.akamai.com/property-mgr/reference/concurrency-control), it includes a top-level `etag` data digest to use when [writing back the data](https://techdocs.akamai.com/property-mgr/reference/put-property-version-rules). Use this operation if you simply want to get the `ETag` as a header without the data. operationId: head-property-version-rules summary: Akamai Get a Digest for 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/head-property-version-rules responses: '204': description: The response provides the `ETag` header representing the current state of the rule tree data. See Concurrency control for guidance. content: '*/*': {} 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 '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: 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/404.yaml '405': description: '[Method not allowed](https://techdocs.akamai.com/property-mgr/reference/405).' content: application/problem+json: example: detail: The system does not support the method you provided for this resource. instance: /papi/v1/properties?contractId=ctr_C-0N7RAC7&groupId=grp_12345#abc12345abcc02a7 status: 405 title: Method not allowed type: https://problems.luna.akamaiapis.net/papi/v1/http/method-not-allowed 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/405.yaml '406': description: '[Not acceptable](https://techdocs.akamai.com/property-mgr/reference/406).' content: application/problem+json: example: detail: The system does not support the content-type restrictions provided by your 'Accept' header. instance: papi/v1/build#abc12345abcc02a7 status: 406 title: Not Acceptable type: https://problems.luna.akamaiapis.net/papi/v1/http/not-acceptable 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/406.yaml '429': description: '[Too many requests](https://techdocs.akamai.com/property-mgr/reference/429).' content: application/problem+json: example: detail: Too many includes exist on contract ctr_1-12345. You must delete an include before continuing. instance: /papi/v1/includes?contractId=ctr_C-0N7RAC7&groupId=grp_12345#abc12345abcc02a7 instanceKey: 1-12345 limit: 500 limitKey: INCLUDES_PER_CONTRACT remaining: 0 status: 429 title: Too many includes type: https://problems.luna.akamaiapis.net/papi/v1/limit-exceeded 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 - limitKey - instanceKey - limit - remaining 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 instanceKey: description: Identifies the resource the limit is imposed on. minLength: 1 type: string limit: description: The overall limit. type: integer limitKey: description: The limit that got exceeded with the operation. minLength: 1 type: string remaining: description: Number of items left to deploy. type: integer 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-429.yaml x-akamai: file-path: errors/429.yaml '500': description: '[Internal server error](https://techdocs.akamai.com/property-mgr/reference/500).' content: application/problem+json: example: detail: Our system is experiencing errors. We''ll get this fixed as soon as possible. instance: /papi/v1/properties/12345/activations#abc12345abcc02a7 status: 500 title: Internal Server Error type: https://problems.luna.akamaiapis.net/papi/proxy/internal-server-error 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/500.yaml parameters: - description: A custom JSON type that validates against a dated rule format. When examining metadata from a [property version](https://techdocs.akamai.com/property-mgr/reference/get-property-version) or include, the content type is `text/xml`. See [API versioning](https://techdocs.akamai.com/property-mgr/reference/api-versioning) for guidance. example: '{{Accept}}' in: header name: Accept required: true schema: example: application/vnd.akamai.papirules.latest+json type: string x-akamai: file-path: parameters/Accept-header.yaml - description: Unique identifier for the contract. The parameter is optional if a property belongs to 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](https://techdocs.akamai.com/property-mgr/reference/id-prefixes) for details on omitting the value's `ctr_` prefix. example: '{{contractId}}' in: query name: contractId required: false schema: example: ctr_1-1TJZFW type: string x-akamai: file-path: parameters/contractId-optional.yaml - description: Unique identifier for the group. The parameter is optional if a property belongs to 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](https://techdocs.akamai.com/property-mgr/reference/id-prefixes) for details on omitting the value's `grp_` prefix. example: '{{groupId}}' in: query name: groupId required: false schema: example: grp_15166 type: string x-akamai: file-path: parameters/groupId-optional.yaml - description: Set to `true` by default. When `false`, skips validation tests that would identify potential problems within the response object's `errors` and `warnings` arrays. See [Rule tree errors and warnings](https://techdocs.akamai.com/property-mgr/reference/rule-tree-errors-and-warnings) and [Validation errors](https://techdocs.akamai.com/property-mgr/reference/validation-errors) for information on how validation data appears in the response object. See [Validation best practices](https://techdocs.akamai.com/property-mgr/reference/validation-best-practices) for guidance on when to defer validation. example: '{{validateRules}}' in: query name: validateRules required: false schema: default: true example: true type: boolean x-akamai: file-path: parameters/validateRules-query.yaml - description: __Enum__ With `validateRules` enabled, setting this to `fast` performs a quick validation check based on the provided JSON. This is faster than the default `full` validation, which performs more extensive checks on the converted XML metadata configuration. See [Validation best practices](https://techdocs.akamai.com/property-mgr/reference/validation-best-practices) for more guidance. example: '{{validateMode}}' in: query name: validateMode required: false schema: default: full example: fast type: string enum: - full - fast x-akamai: file-path: parameters/validateMode-query.yaml - description: For customers who manage more than one account, this [runs the operation from another account](https://techdocs.akamai.com/developer/docs/manage-many-accounts-with-one-api-client). The Identity and Access Management API provides a [list of available account switch keys](https://techdocs.akamai.com/iam-api/reference/get-client-account-switch-keys). example: '{{accountSwitchKey}}' in: query name: accountSwitchKey required: false schema: example: 1-5C0YLB:1-8BYUX type: string externalDocs: description: See documentation for Akamai's API Endpoint Definition API url: https://techdocs.akamai.com/api-definitions/reference x-readme: samples-languages: - curl - python - node