API
Start typing to search…

Patch a property's rule tree

patch
https://{hostname}/papi/v1/properties//versions//rules

Selectively modify a rule tree using JSON patch syntax. As a component of the larger Bulk patch a set of properties, this operation patches an individual rule tree. See Bulk Search and Update for more information.

With the updateRules query parameter defaulting to true, you can continuously use the latest rule format and keep working with your current rule tree without causing new validation errors as Akamai dynamically modifies catalog options. See Dynamic rule updates for more details.

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 for guidance on when to defer validation.

See Rule tree errors and warnings and Validation errors for information on how validation data is embedded within the response object.

Path Params
string
required

Unique identifier for the property. See ID prefixes for details on omitting the value's prp_ prefix.

integer
required

Property's incremental version number.

Query Params
string

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 for details on omitting the value's ctr_ prefix.

string

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 for details on omitting the value's grp_ prefix.

boolean
Defaults to true

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 and Validation errors for information on how validation data appears in the response object. See Validation best practices for guidance on when to defer validation.

string
enum
Defaults to full

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 for more guidance.

Allowed:
boolean
Defaults to false

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 for more guidance.

boolean
Defaults to true

When true, PAPI outputs a property's rule tree in the original form provided by the PUT operation, deliberately suppressing any updates. When set to true, PAPI still upgrades catalog features in the background each time you run GET and PATCH operations on property version rules, but the response yields the rule tree just as you last saved it. The parameter defaults to true.

boolean
Defaults to true

When true, PAPI upgrades the input rule tree object to ensure backwards compatibility. You can continuously use the latest rule format and keep working with your current rule tree without causing new validation errors as Akamai dynamically modifies catalog options. Upgrade applies renames, transformations, fills in default values for new features, and removes extraneous options.

string

For customers who manage more than one account, this runs the operation from another account. The Identity and Access Management API provides a list of available account switch keys.

Body Params
Headers
string
required

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 for details.

string
enum
required

Enum Sets whether to represent ID prefixes in response data. Set to false when exchanging PAPI data with other APIs.

Allowed:
string
enum
Defaults to application/problem+json

Generated from available response content types

Allowed:
Responses

Updated about 1 month ago

Language
URL
Response 
 Choose an example:
*/*
application/problem+json
Updated about 1 month ago