API
Start typing to search…

Get a property's rule tree

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

Gets the entire rule tree for a property version. See the Rule Trees section for details on the response object's structure.

Also use this operation to:

If the response includes any validation errors, you need to resolve them before activating the property version.

Recipes
Get a property rule tree
Open Recipe
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
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.

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.

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.

Headers
string
required

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

Responses

Response body
object
string

Identifies the prevailing account under which you requested the data. See ID prefixes for details on how to omit the ID's act_ prefix.

string

Identifies the prevailing contract under which you requested the data. See ID prefixes for details on how to omit the ID's ctr_ prefix.

string

A digest with which to check the data's integrity.

string

Identifies the prevailing group under which you requested the data. See ID prefixes for details on how to omit the ID's grp_ prefix.

string

Identifies the property a rule tree represents. See 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.

string

A unique, descriptive name for the property. It's not modifiable after you initially create it on a POST request.

integer
≥ 1

The version of the property that a rule tree represents.

string

Indicates the versioned set of features and criteria that are currently applied to a rule tree. See API versioning for more information.

rules
object

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 section for guidance on how to structure the data.

options
object

Flags that apply to the top-level rule object.

string

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.

behaviors
array of objects
required

A series of behavior objects, which execute after the set of criteria evaluates. Behavior and criteria objects are structured identically. Optional on nested rules.

behaviors*
object
options
object
required

A variable set of options that configure each behavior. See the behavior and criteria reference for details on each.

Has additional fields
string

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.

string
required

The name of the behavior.

string

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.

children
array of objects
length ≥ 0

A series of nested rules that execute after the current rule's criteria and behaviors.

children
object
string

A descriptive comment to help you track the rule's function.

criteria
array of objects

A series of 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.

criteria
object
boolean

Within child rules, this prohibits any modifications to criteria objects. Contact your Akamai representative to change the value.

customOverride
object

Specifies post-processing XML metadata that your Akamai representative can create on your behalf. Once available with the List custom overrides operation, you can assign an overrideId to more than one property's default rule. See Custom behaviors and overrides for guidance.

string
required

A description of the rule. The top-level rule needs to be named default.

string

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.

variables
array of objects
length ≥ 0

Declares a variable. See Variables for guidance on how variables may appear within a rule tree.

variables
object
string

Text for you to keep track of how you use each variable.

boolean
required

When enabled, the variable is suppressed from session response headers. Useful when testing content as described in the Debug variables section.

string
required

The underlying root name of the variable, which needs to be unique within the set of variables.

boolean
required

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.

string

Initializes a default value. Omitting this member initializes the variable with an empty string.

Headers
object
string

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

string

Maximum number of separate Client IP matches per property rule tree configuration.

string

Remaining number of separate Client IP matches per property rule tree configuration. See Rate and resource limiting for details.

string

Maximum number of separate matches and behaviors per property rule tree configuration. See Rate and resource limiting for details.

string

Remaining number of separate matches and behaviors per property rule tree configuration. See Rate and resource limiting for details.

string

Maximum number of separate IP addresses allowed within each Client IP match.

string

Remaining number of separate IP addresses allowed within each Client IP match. See Rate and resource limiting for details.

string

Maximum number of nested child rules in a property to apply conditional logic.

string

Remaining number of nested child rules in a property to apply conditional logic. See Rate and resource limiting for details.

integer

Maximum sustainable number of request allowed each minute per account. This rate limit protects PAPI resources from being exhausted by single users. Once you exceed the limit, you receive the 429 error. If you call PAPI using multiple API clients within the same account, the rate limit applies globally to all API clients.

This API also provides a burst limit that specifies how many requests you can make in excess of the imposed rate limit. The one-time burst limit is 1000 requests. Once you consume all available resources, the burst capacity increases steadily by 100 requests every minute, until it reaches its initial maximum limit of 1000.

integer

Remaining number of requests allowed each minute per account. See Rate and resource limiting for details.

Updated 3 months ago

Did this page help you?
Language
URL

Updated 3 months ago

Did this page help you?