API

Update an include's rule tree

put
https://{hostname}/papi/v1/includes//versions//rules

Limited availability To write a rule tree to an include version, make a PUT request to the same resource as the GET request that reads it, passing in the rule object in the body of the request. See the Rule Trees section for details on the rule tree's structure. Use this operation also to freeze a set of rules 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 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 include. See ID prefixes for details on omitting the value's inc_ prefix.

integer
required

Include'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 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

Specifies the executable logic to apply to cached edge content.

rules
object

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

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:
string
enum
Defaults to application/json

Generated from available request content types

Allowed:
Responses

Updated 4 months ago

Language
URL
LoadingLoading…
Response
Click Try It! to start a request and see the response here! Or choose an example:
*/*
application/problem+json

Updated 4 months ago