API
Start typing to search…

Activate a policy version

post https://{hostname}/cloudlets/v3/policies//activations

Asynchronously activates or deactivates the selected Cloudlet policy version on the staging or production networks. When a policy version becomes active on the network, the previously active version gets automatically deactivated. Activating a policy version returns the id of the activation, which you can store and use to run the Get status for an activation operation to check the status value. You can activate a policy on each network only after any previous activations have completed, otherwise you get a 409 error.

Path Params
integer
required

Identifies the shared policy.

Query Params
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
string
required

The networks where you can activate or deactivate the policy version, either PRODUCTION or STAGING.

string
required

The operations that you can perform on a policy version, either ACTIVATION or DEACTIVATION.

integer
required

Identifies the policy version.

Responses

Response body
object | null
string
required

The username who created the activation.

date-time
required

ISO 8601 timestamp indicating when the activation was created.

string

A detailed description of the reason why the activation failed.

date-time | null

ISO 8601 timestamp indicating when the activation ended, either successfully or unsuccessfully. You can check details of unsuccessful attempts in failureDetails.

integer
required

Identifies the activation.

links
array of objects

Hypermedia links to help navigate through the result set.

links
object
string
required

A relative path to the currently requested object or a specific page of the result set.

string
required

The relationship between the current and linked result sets. A value of self links to the current result set, while first, next, and last link to different sets of paginated data.

string
required

The networks where you can activate or deactivate the policy version, either PRODUCTION or STAGING.

PRODUCTION STAGING

string
required

The operations that you can perform on a policy version, either ACTIVATION or DEACTIVATION.

ACTIVATION DEACTIVATION

integer
required

Identifies the shared policy.

integer
required

The number of the policy version.

boolean

Indicates if the policy version is deleted.

string
required

The status of the operation, either IN_PROGRESS, SUCCESS, or FAILED.

IN_PROGRESS SUCCESS FAILED

Updated 5 months ago

Did this page help you?
Language
Authentication
Remember to add your authentication credentials to run this code.
URL

Updated 5 months ago

Did this page help you?