List include versions

get https://{hostname}/papi/v1/includes/{includeId}/versions

Limited availability Lists the include's versions, with results limited to the 500 most recent versions. Optionally paginate the results. Each include version indicates an activation status on different networks, and an etag digest useful when cloning the include.

Recipes

Open Recipe

Path Params

includeId

string

required

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

Query Params

offset

integer

≥ 0

For paginated responses, specifies the page of results you want to navigate to, starting from 0.

limit

integer

≥ 1

For paginated responses, specifies the number of hostnames objects to include on each page.

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

required

Enum Sets whether to represent ID prefixes in response data. Set to false when exchanging PAPI data with other APIs.

Responses

Response body

object

accountId

string

Identifies the prevailing account under which you requested the data. See ID prefixes for details on how to omit the ID's act_ prefix.

assetId

string

An alternative identifier for the include. Use this value to key the include in the Identity and Access Management API. See Manage properties and includes.

contractId

string

Identifies the prevailing contract under which you requested the data. See ID prefixes for details on how to omit the ID's ctr_ prefix.

groupId

string

Identifies the prevailing group under which you requested the data. See ID prefixes for details on how to omit the ID's grp_ prefix.

includeId

string

The include's unique identifier. See ID prefixes for details on how to omit the ID's inc_ prefix.

includeName

string

A unique, descriptive name for the include. It's not modifiable after you initially create it on a POST request.

includeType

string

The type of an include. MICROSERVICES specifies includes with a separate access control and activation flow, which allows different teams to work independently on different parts of a single site. In a parent property's rule tree, you add the MICROSERVICES includes to rules with mutually exclusive path matches. COMMON_SETTINGS specifies includes used across different properties that share a significant number of settings. In a parent property's rule tree, you add the COMMON_SETTINGS includes to the default rule or rules without any matches. By updating or activating a single COMMON_SETTINGS include, the changes take effect immediately across all sites that use this include. You can use this member for filtering and grouping similar includes together.

COMMON_SETTINGS MICROSERVICES

versions

object

The set of requested include versions, available within an items array.

items

array of objects

Specifies the version of an include. Relevant response objects appear within the outer envelope's versions.items array.

items

object

etag

string

required

A digest with which to check the data's integrity. See Concurrency control for guidance.

includeVersion

integer

required

≥ 1

A positive integer identifying the incremental version.

note

string

required

A descriptive log comment.

productId

string

required

The product assigned to the include when versioned. See ID prefixes for details on how to omit the ID's inc_ prefix.

productionStatus

string

required

Whether the version has been activated to the production network. If ACTIVE, the version is read-only. It's INACTIVE if another version has superseded this one. It's PENDING if the activation request is in progress. It's PENDING_CANCELLATION or ABORTED if the client cancelled a pending activation in time. It's PENDING_DEACTIVATION or DEACTIVATED when set to no longer serve traffic.

ACTIVE INACTIVE PENDING ABORTED DEACTIVATED PENDING_DEACTIVATION PENDING_CANCELLATION

ruleFormat

string

Identifies the rule format currently assigned to the include version's rule tree.

stagingStatus

string

required

Whether the version has been activated to the test network. If ACTIVE, the version is read-only. It's INACTIVE if another version has superseded this one. It's PENDING if the activation request is in progress. It's PENDING_CANCELLATION or ABORTED if the client cancelled a pending activation in time. It's PENDING_DEACTIVATION or DEACTIVATED when set to no longer serve traffic.

ACTIVE INACTIVE PENDING ABORTED DEACTIVATED PENDING_DEACTIVATION PENDING_CANCELLATION

updatedByUser

string

required

The username who last updated the version.

updatedDate

string

required

The date stamp of the version's latest update.

Headers

object

X-RateLimit-Limit

integer

Maximum sustainable number of request allowed each minute per account. This rate limit protects PAPI resources from being exhausted by single users. Once you exceed the limit, you receive the 429 error. If you call PAPI using multiple API clients within the same account, the rate limit applies globally to all API clients.

This API also provides a burst limit that specifies how many requests you can make in excess of the imposed rate limit. The one-time burst limit is 1000 requests. Once you consume all available resources, the burst capacity increases steadily by 100 requests every minute, until it reaches its initial maximum limit of 1000.

X-RateLimit-Remaining

integer

Remaining number of requests allowed each minute per account. See Rate and resource limiting for details.

Language

Authentication

Remember to add your authentication credentials to run this code.

URL


xxxxxxxxxx
1
curl --request GET \
2
     --url https://hostname/papi/v1/includes/includeId/versions \
3
     --header 'PAPI-Use-Prefixes: true' \
4
     --header 'accept: application/json'


xxxxxxxxxx
35
}
1
{
2
  "accountId": "act_A-CCT7890",
3
  "assetId": "aid_101",
4
  "contractId": "ctr_K-0N7RAK71",
5
  "groupId": "grp_32145",
6
  "includeId": "inc_173136",
7
  "includeName": "my.new.include.com",
8
  "includeType": "COMMON_SETTINGS",
9
  "versions": {
10
    "items": [
11
      {
12
        "etag": "5891b5b522d5df08",
13
        "includeVersion": 2,
14
        "note": "updated caching",
15
        "productId": "prd_Alta",
16
        "productionStatus": "INACTIVE",
17
        "ruleFormat": "v2022-10-18",
18
        "stagingStatus": "ACTIVE",
19
        "updatedByUser": "jsmith",
20
        "updatedDate": "2022-10-22T19:06:13Z"
21
      },
22
      {
23
        "etag": "71573b922a87abc3",
24
        "includeVersion": 1,
25
        "note": "initial version",

200The response lists include versions for the requested include.

400Bad request.

401Unauthorized.

403Forbidden.

404Not found.

405Method not allowed.

406Not acceptable.

429Too many requests.

500Internal server error.