API workflow

The following is the basic workflow you need to follow when creating a new Cloudlet policy.

If you are using Conditional Origins or are setting up the Application Load Balancer Cloudlet, see API workflow for conditional origins. Application Load Balancer always uses Cloudlets Origins.

  1. Run a GET request on the /cloudlets/api/v2/cloudlet-info endpoint to retrieve the ID (cloudletId) for the Cloudlet you are working with. You need the cloudletId when creating a new policy.

  2. Run a GET request on the /cloudlets/api/v2/group-info endpoint to retrieve information about which Cloudlets are associated with the groups you have edit privileges for. You will need the group IDs (groupId) returned when creating a Cloudlet policy.

  3. Using the /cloudlets/api/v2/policies endpoint, run a POST to create a Cloudlet policy using the cloudletId and groupId you retrieved from the previous steps.
    The policy created is version 1. This new version does not have a description and does not include match rules (matchRules) attributes.


You have the option of using query parameters to clone an existing policy.

  1. Update the new policy version 1 by running a PUT request on the /cloudlets/api/v2/policies/{policyId}/versions/{version} endpoint that includes a version description and match rules. The policyId is returned in the response when the Cloudlet policy is created.

  2. If you need to review the current property associations for the policy version before activating, run a GET request on the /cloudlets/api/v2/policies/{policyId}/properties endpoint.


This operation also returns information about any Conditional Origins configured on an associated property. If you are using a Cloudlet that supports Conditional Origins, you may want to verify that the information returned about these origins is accurate.

  1. Activate the policy by running a POST request to the /cloudlets/api/v2/policies/{policyId}/versions/{version}/activations endpoint.

  2. Using the Property Manager API (PAPI) set up the behavior for each Cloudlet you are configuring:

  1. Using PAPI, activate the property version that includes your Cloudlets behavior changes.