Get an include

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

Limited availability This operation gets a specific include. You can call this operation by specifying any of the includeId members from a list of includes, or by running a GET on the includeLink response when creating a new include.

Recipes

Get an include

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

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.

Responses

Response body

object

includes

object

The set of requested includes, available within an items array.

items

array of objects

Configuration data to apply to edge content. Relevant response objects appear within the outer envelope's include.items array.

items

object

accountId

string

required

Identifies the account the include belongs to. See ID prefixes for details on how to omit the ID's act_ prefix.

assetId

string

required

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

required

Identifies the contract the include belongs to. See ID prefixes for details on how to omit the ID's ctr_ prefix.

groupId

string

required

Identifies the group to which the include is assigned. 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

latestVersion

integer

required

≥ 1

Specifies the most recent version of the include.

note

string

Further descriptive commentary.

productionVersion

integer | null

required

≥ 1

The most recent version to be activated to the production network, otherwise null.

propertyType

string

Indicates the type of configuration container, mostly used for the Bulk Search and Update operation.

INCLUDE

stagingVersion

integer | null

required

≥ 1

The most recent version to be activated to the test network, otherwise null.

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

Remianing 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 \
# Add Authorization header to this snippet
3
     --header 'accept: application/json'


xxxxxxxxxx
19
 
1
{
2
  "includes": {
3
    "items": [
4
      {
5
        "accountId": "act_A-CCT5678",
6
        "assetId": "aid_101",
7
        "contractId": "ctr_K-0N7RAK7",
8
        "groupId": "grp_12345",
9
        "includeId": "inc_243237",
10
        "includeName": "my.new.include.com",
11
        "includeType": "COMMON_SETTINGS",
12
        "latestVersion": 2,
13
        "productionVersion": null,
14
        "propertyType": "INCLUDE",
15
        "stagingVersion": 1
16
      }
17
    ]
18
  }
19
}

200The response shows details for the requested include.

400Bad request.

401Unauthorized.

403Forbidden.

404Not found.

405Method not allowed.

406Not acceptable.

429Too many requests.

500Internal server error.