{ "opencollection": "1.0.0", "info": { "name": "Akamai: API Endpoint Definition Access tokens Property version rules API", "version": "2" }, "items": [ { "info": { "name": "Property version rules", "type": "folder" }, "items": [ { "info": { "name": "Akamai Get a Property's Rule Tree", "type": "http" }, "http": { "method": "GET", "url": "https://{hostname}/api-definitions/v2/properties/:propertyId/versions/:propertyVersion/rules", "headers": [ { "name": "PAPI-Use-Prefixes", "value": "{{PAPI-Use-Prefixes}}" } ], "params": [ { "name": "propertyId", "value": "{{propertyId}}", "type": "path", "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." }, { "name": "propertyVersion", "value": "{{propertyVersion}}", "type": "path", "description": "Property's incremental version number." }, { "name": "contractId", "value": "{{contractId}}", "type": "query", "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." }, { "name": "groupId", "value": "{{groupId}}", "type": "query", "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." }, { "name": "validateRules", "value": "{{validateRules}}", "type": "query", "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." }, { "name": "validateMode", "value": "{{validateMode}}", "type": "query", "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." }, { "name": "accountSwitchKey", "value": "{{accountSwitchKey}}", "type": "query", "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)." } ] }, "docs": "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)." }, { "info": { "name": "Akamai Update a Property's Rule Tree", "type": "http" }, "http": { "method": "PUT", "url": "https://{hostname}/api-definitions/v2/properties/:propertyId/versions/:propertyVersion/rules", "headers": [ { "name": "If-Match", "value": "{{If-Match}}" }, { "name": "PAPI-Use-Prefixes", "value": "{{PAPI-Use-Prefixes}}" } ], "params": [ { "name": "propertyId", "value": "{{propertyId}}", "type": "path", "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." }, { "name": "propertyVersion", "value": "{{propertyVersion}}", "type": "path", "description": "Property's incremental version number." }, { "name": "contractId", "value": "{{contractId}}", "type": "query", "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." }, { "name": "groupId", "value": "{{groupId}}", "type": "query", "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." }, { "name": "validateRules", "value": "{{validateRules}}", "type": "query", "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." }, { "name": "validateMode", "value": "{{validateMode}}", "type": "query", "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." }, { "name": "dryRun", "value": "{{dryRun}}", "type": "query", "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." }, { "name": "accountSwitchKey", "value": "{{accountSwitchKey}}", "type": "query", "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)." } ], "body": { "type": "json", "data": "{}" } }, "docs": "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 n" }, { "info": { "name": "Akamai Patch a Property's Rule Tree", "type": "http" }, "http": { "method": "PATCH", "url": "https://{hostname}/api-definitions/v2/properties/:propertyId/versions/:propertyVersion/rules", "headers": [ { "name": "If-Match", "value": "{{If-Match}}" }, { "name": "PAPI-Use-Prefixes", "value": "{{PAPI-Use-Prefixes}}" } ], "params": [ { "name": "propertyId", "value": "{{propertyId}}", "type": "path", "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." }, { "name": "propertyVersion", "value": "{{propertyVersion}}", "type": "path", "description": "Property's incremental version number." }, { "name": "contractId", "value": "{{contractId}}", "type": "query", "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." }, { "name": "groupId", "value": "{{groupId}}", "type": "query", "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." }, { "name": "validateRules", "value": "{{validateRules}}", "type": "query", "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." }, { "name": "validateMode", "value": "{{validateMode}}", "type": "query", "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." }, { "name": "dryRun", "value": "{{dryRun}}", "type": "query", "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." }, { "name": "accountSwitchKey", "value": "{{accountSwitchKey}}", "type": "query", "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)." } ], "body": { "type": "json", "data": "{}" } }, "docs": "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 `validat" }, { "info": { "name": "Akamai Get a Digest for a Property's Rule Tree", "type": "http" }, "http": { "method": "HEAD", "url": "https://{hostname}/api-definitions/v2/properties/:propertyId/versions/:propertyVersion/rules", "headers": [ { "name": "Accept", "value": "{{Accept}}" } ], "params": [ { "name": "propertyId", "value": "{{propertyId}}", "type": "path", "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." }, { "name": "propertyVersion", "value": "{{propertyVersion}}", "type": "path", "description": "Property's incremental version number." }, { "name": "contractId", "value": "{{contractId}}", "type": "query", "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." }, { "name": "groupId", "value": "{{groupId}}", "type": "query", "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." }, { "name": "validateRules", "value": "{{validateRules}}", "type": "query", "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." }, { "name": "validateMode", "value": "{{validateMode}}", "type": "query", "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." }, { "name": "accountSwitchKey", "value": "{{accountSwitchKey}}", "type": "query", "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)." } ] }, "docs": "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" } ] } ], "bundled": true }