Bulk activations

Once you bulk patch a set of property versions, you can bulk activate them.

Launch a bulk activate job

Build an object as in the example below. From the set of patchPropertyVersions you updated earlier, pass in this data:

propertyId
propertyVersion
optional etag value
any note you want to include for each property's activation
the network to activate on, either STAGING or PRODUCTION

👍
Bulk activate to STAGING and test thoroughly on more than one property before bulk activating to PRODUCTION.

In addition to the properties you want to activate, you also need to specify global settings that apply to all the activations. Specify these defaultActivationSettings:

a common set of notifyEmails to inform people of changes to activation status.
"acknowledgeAllWarnings":true if configurations include any routine warnings.

{
    "defaultActivationSettings": {
        "acknowledgeAllWarnings": true,
        "notifyEmails": [
            "you@example.com",
            "them@example.com"
        ]
    },
    "activatePropertyVersions": [
        {
            "propertyId": "prp_15",
            "propertyVersion": 3,
            "note": "Testing new origin host for 'prp_15' v3",
            "network": "STAGING"
        },
        {
            "propertyId": "prp_3",
            "propertyVersion": 11,
            "note": "Testing new origin host for 'prp_3' v11",
            "network": "STAGING"
        }
    ]
}

Once you've built the object as in this example, POST it to this URL:

POST /papi/v1/bulk/activations

For details on this operation, see Bulk activate a set of properties

As with all bulk POST operations, the response object includes a URL link to poll for status on the activations. This bulkActivationLink is also available in the response's Location header:

{
    "bulkActivationLink": "/papi/v1/bulk/activations/311"
}

📘
You're limited to 100 activations for both the staging and production networks for each day within an account. Make sure your bulk activation request doesn't exceed that limit, which includes conventional non-bulk activation requests over the same period. See Rate and resource limiting for details.

Check bulk activate status

GET the URL link from the response discussed above to check bulk activation progress. See List bulk-activated properties for details on this operation.

As with all bulk operations, the GET response features all the original requested data, but with additional data to reflect the status of the activations. Some of the global defaultActivationSettings are also repeated within each of the activatePropertyVersions:

{
    "bulkActivationId": 234,
    "bulkActivationStatus": "NEW",
    "bulkActivationSubmitDate": "2018-01-18T00:00:00Z",
    "bulkActivationUpdateDate": "2018-01-18T01:00:00Z",
    "defaultActivationSettings": {
        "acknowledgeAllWarnings": true,
        "useFastFallback": false,
        "fastPush": true,
        "notifyEmails": [
            "you@example.com",
            "them@example.com"
        ]
    },
    "activatePropertyVersions": [
        {
            "propertyId": "prp_15",
            "propertyVersion": 3,
            "note": "Testing new origin host for 'prp_15' v3",
            "network": "STAGING",
            "acknowledgeAllWarnings": true,
            "activationStatus": "ACTIVATED",
            "activationSubmitDate": "2018-01-18T00:00:00Z",
            "activationUpdateDate": "2018-01-18T00:00:00Z",
            "fastPush": true,
            "propertyActivationLink": "/papi/v1/properties/prp_1/activations/act_1",
            "useFastFallback": false,
            "notifyEmails": [
                "you@example.com",
                "them@example.com"
            ]
        },
        {
            "propertyId": "prp_3",
            "propertyVersion": 11,
            "note": "Testing new origin host for 'prp_3' v11",
            "network": "STAGING",
            "acknowledgeAllWarnings": true,
            "activationStatus": "ACTIVATING",
            "activationSubmitDate": "2018-01-18T00:00:00Z",
            "activationUpdateDate": null,
            "fastPush": true,
            "propertyActivationLink": "/papi/v1/properties/prp_1/activations/act_2",
            "useFastFallback": false,
            "notifyEmails": [
                "you@example.com",
                "them@example.com"
            ]
        }
    ]
}

As with all of PAPI's bulk operations, the GET response's top-level object indicates the status of the overall bulk job. If the bulkActivationStatus isn't yet COMPLETE, GET it again later. Once the bulkActivationStatus is COMPLETE, check each activatePropertyVersions object. If the activationStatus is ACTIVATED, the property is serving live traffic. Your bulk update is complete.