Get a property version
GET https://{{host}}/papi/v1/properties/:propertyId/versions/:propertyVersion
This polls the state of a specific property 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 a property version. This XML data encapsulates the property version's component rules and hostnames, 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_K-0N7RAK71","groupId":"grp_12345","propertyId":"prp_173136","propertyName":"981.catalog.jsmith.net","versions":{"items":[{"etag":"71573b922a87abc3","note":"initial version","productId":"prd_Alta","productionStatus":"ACTIVE","propertyVersion":1,"ruleFormat":"latest","stagingStatus":"INACTIVE","updatedByUser":"jsmith","updatedDate":"2014-03-04T21:12:57Z"}]}}