Get a property activation

get https://{hostname}/papi/v1/properties/{propertyId}/activations/{activationId}

Gets details about an activation. You typically get a single activation from an activationLink when launching a new activation and following up to poll its status. For activations whose status is PENDING, a Retry-After header provides an estimate for when it's likely to change.

Note: To reduce errors, avoid calling PAPI with separate clients on the same data. Avoid frequently polling status values. Instead, progressively increase the delay between calls.

Recipes

Get an activation

Open Recipe

Path Params

propertyId

string

required

Unique identifier for the property. See ID prefixes for details on omitting the value's prp_ prefix.

activationId

string

required

Unique identifier for the property or include activation.

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

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

length ≥ 1

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

activations

object

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

items

array of objects

Activated property versions on a specific network. Relevant response objects appear within the outer envelope's activations.items array.

items

object

accountId

string

Identifies the account under which the property activated. See ID prefixes for details on how to omit the ID's act_ prefix.

activationId

string

required

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

activationType

string

required

Either ACTIVATE or DEACTIVATE. The default is ACTIVATE. Any new activation automatically deactivates the current activation. Note that if you were to POST a DEACTIVATE type on an active property, it would no longer serve any traffic. You'd need to modify your DNS configuration and specify a different way to field the traffic.

ACTIVATE DEACTIVATE

failureCause

object

If the activation's status is FAILED, this HTTP problem object describes the reason for the failure. This only appears when activating with delayValidations enabled.

Has additional fields

fallbackInfo

object

Encapsulates information about fast fallback. You can use it to fall back to a previous activation when POSTing an activation with useFastFallback enabled.

fmaActivationState

string

Indicates fast metadata activation state. A value of steady indicates the property is currently active or has been cancelled. Values of received, lived, and deployed represent progressive stages of activation, while cancelling happens either after failing a network safety check or in response to a DELETE operation. Note that the status member indicates whether the activation is live.

steady received lived deployed cancelling

groupId

string

Identifies the group under which the property activated. See ID prefixes for details on how to omit the ID's grp_ prefix.

network

string

required

The network to activate on, either STAGING or PRODUCTION.

STAGING PRODUCTION

note

string

required

Assigns a log message to the activation request.

notifyEmails

array of strings

required

length ≥ 0

Email addresses to notify when the activation status changes.

notifyEmails*

propertyId

string

required

Identifies property targeted with activation. See ID prefixes for details on how to omit the ID's prp_ prefix. Don't use this value if you want to exchange data with the Identity and Access Manager API. See Manage properties and includes.

propertyName

string

required

The name of the property targeted with activation.

propertyVersion

integer

≥ 1

The property version targeted with activation. Once activated, you can no longer modify that version of the property.

status

string

required

The activation's status. ACTIVE if currently serving traffic. INACTIVE if another activation has superseded this one. NEW, PENDING, ZONE_1, ZONE_2, or ZONE_3 if not yet active. ABORTED if the client followed up with a DELETE request in time. FAILED if the activation causes a range of edge network errors that may cause a fallback to the previous activation. PENDING_DEACTIVATION or DEACTIVATED when the activationType is DEACTIVATE to no longer serve traffic.

ACTIVE INACTIVE PENDING ZONE_1 ZONE_2 ZONE_3 ABORTED FAILED DEACTIVATED PENDING_DEACTIVATION NEW

submitDate

string

required

A date stamp marking when the activation initiated.

updateDate

string

required

A date stamp marking when the status last changed.

contractId

string

length ≥ 1

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

length ≥ 1

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

Headers

object

Retry-After

string

For activations whose status remains PENDING, this specifies the number of seconds it will likely take to go live.

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/properties/propertyId/activations/activationId \
# Add Authorization header to this snippet
3
     --header 'PAPI-Use-Prefixes: true' \
4
     --header 'accept: application/json'


xxxxxxxxxx
34
}
1
{
2
  "accountId": "act_A-CCT7890",
3
  "activations": {
4
    "items": [
5
      {
6
        "activationId": "atv_1696985",
7
        "activationType": "ACTIVATE",
8
        "fallbackInfo": {
9
          "canFastFallback": true,
10
          "fallbackVersion": 10,
11
          "fastFallbackAttempted": false,
12
          "fastFallbackExpirationTime": 1506451772,
13
          "fastFallbackRecoveryState": null,
14
          "steadyStateTime": 1506448172
15
        },
16
        "fmaActivationState": "steady",
17
        "network": "STAGING",
18
        "note": "Sample activation",
19
        "notifyEmails": [
20
          "you@example.com",
21
          "them@example.com"
22
        ],
23
        "propertyId": "prp_173136",
24
        "propertyName": "example.com",
25
        "propertyVersion": 1,

200The response shows the property activation details.

400Bad request.

401Unauthorized.

403Forbidden.

404Not found.

405Method not allowed.

406Not acceptable.

429Too many requests.

500Internal server error.