Activate a policy version

post

https://{hostname}/cloudlets/api/v2/policies/{policyId}/versions/{version}/activations

Activate the selected Cloudlet policy version. After activation completes, the Cloudlets policy is ready for use. You can't activate a non-shared policy on staging and production simultaneously. Wait until the first activation is PENDING before starting another on either network.

Path Params

version

number

required

The version number of the policy.

policyId

integer

required

The ID of the policy.

Query Params

async

boolean

Defaults to false

Set async to true for policy activations on multiple properties to reduce API response time and let the policy activation continue asynchronously in the background. Default is false.

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.

Body Params

additionalPropertyNames

array of strings

An array of one or more additional properties that you want to activate with the Cloudlet policy. Once activated, the property and policy are permanently linked.

additionalPropertyNames

ignoreHttpErrors

boolean

Defaults to false

Specifies whether to ignore any HTTP errors that result from the Cloudlets policy you're activating. When set to the default false, any spike in HTTP errors caused by a misconfigured policy cancels the activation. Make sure to test your policy version activation in the staging network before setting this to true to bypass the safety measure in the production network.

network

string

enum

The network, either STAGING, PRODUCTION, or prod as shorthand, on which a load balancing configuration for Application Load Balancer has been activated. Values are case-insensitive in requests.

Allowed:

Responses

200Returns the activation history for the policy.

429Rate limiting error. You've reached the maximum number of requests for this operation within the current rate limit window. See Rate limits for more information.