Get an include version
GET https://{{host}}/papi/v1/includes/:includeId/versions/:includeVersion
Limited availability This polls the state of a specific include version, for example to check its activation status. When specifying Accept: text/xml, this operation provides the Akamai metadata configuration data that's distributed to edge servers when you activate an include version. This XML data encapsulates the include version's component rules and is available on a read-only basis. Contact your Akamai representative if you need help interpreting it.
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. | |
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-CCT9012","assetId":"aid_101","contractId":"ctr_C-0N7RAC71","groupId":"grp_12345","includeId":"inc_173136","includeName":"my.new.include.com","includeType":"COMMON_SETTINGS","versions":{"items":[{"etag":"5891b5b522d5df08","includeVersion":2,"note":"updated caching","productId":"prd_Alta","productionStatus":"INACTIVE","ruleFormat":"v2022-10-18","stagingStatus":"ACTIVE","updatedByUser":"jsmith","updatedDate":"2022-10-22T19:06:13Z"}]}}