Get an include version

get

https://{hostname}/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.

Path Params

includeId

string

required

Unique identifier for the include. See ID prefixes for details on omitting the value's inc_ prefix.

includeVersion

integer

required

Include's incremental version number.

Query Params

contractId

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.

groupId

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.

accountSwitchKey

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

PAPI-Use-Prefixes

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/json

Generated from available response content types

Allowed:

Responses

200The response shows details of the requested include version.

400Bad request.

401Unauthorized.

403Forbidden.

404Not found.

405Method not allowed.

406Not acceptable.

429Too many requests.

500Internal server error.