Get an include's rule tree
GET https://{{host}}/papi/v1/includes/:includeId/versions/:includeVersion/rules
Limited availability Gets the entire rule tree for an include version. See the 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.
Request Params
| Key | Datatype | Required | Description |
|---|---|---|---|
contractId | string | (Optional) 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. | |
groupId | string | (Optional) 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. | |
validateRules | string | (Optional) 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. | |
validateMode | string | (Optional) 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. | |
originalInput | string | (Optional) Output rules in the original form provided by the PUT call instead of the system's view. | |
accountSwitchKey | string | (Optional) 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
| Key | Datatype | Required | Description |
|---|---|---|---|
PAPI-Use-Prefixes | string | (Required) Enum Sets whether to represent ID prefixes in response data. Set to false when exchanging PAPI data with other APIs. | |
Accept | string |
RESPONSES
status: OK
{"accountId":"act_A-CCT3456","contractId":"ctr_C-0N7RAC7","etag":"a9dfe78cf93090516bde891d009eaf57","groupId":"grp_12345","includeId":"inc_173136","includeName":"my.new.include.com","includeType":"MICROSERVICES","includeVersion":3,"ruleFormat":"v2022-10-18","rules":{"options":{"is_secure":false},"behaviors":[{"options":{"cacheKeyHostname":"ORIGIN_HOSTNAME","compress":true,"enableTrueClientIp":false,"forwardHostHeader":"REQUEST_HOST_HEADER","hostname":"origin.com","httpPort":80,"originType":"CUSTOMER"},"name":"origin"},{"options":{"value":{"id":12345,"name":"my CP code"}},"name":"cpCode"}],"children":[],"criteria":[],"name":"default"}}