API
TrainingSupportCommunity

Concepts

When working with Cloudlets, you need to be familiar with these terms:

  • Policies. For each Cloudlet on your contract, there can be any number of policies. Policies are versioned. Within a policy version you define the rules that determine when the Cloudlet executes. Each policy is assigned a unique ID policyId. A legacy policy, or a non-shared policy, can only be assigned to one property in Property Manager.

  • Shared policies. A shared policy can be used for an unlimited number of properties. This is the only policy type that API version 3 supports. The only interaction with a legacy (non-shared) policy in this API version is to upgrade it to a shared policy. Unlike legacy policies, once a shared policy is activated it's available on your network for any property. See the the response object from the Get a policy operation.

  • Properties. A property configuration includes all the rules for how to process end-user requests for either a specific web asset or a set of assets. For more information about properties, see the Property Manager API.

  • Policy version. A specific revision of a given policy (policyId). Policy version numbers start at 1 and increment as new versions are created for a policy. You may want to create a new version of a policy to support a different business requirement, or to test new functionality. When you activate a Cloudlet, you're activating a specific version of a Cloudlet policy. See the response object from the Get a policy version operation. If a policy version is being activated or has been activated it is immutable, meaning you can't modify it.

  • Groups. Within an account, there's a hierarchy of groups that control access to both properties and Cloudlets policies. If your Akamai username isn't associated with the group ID (gid or groupId) being used with this API, then the request fails. In addition, you can only associate a Cloudlet policy with a property that's in a compatible group, which can either be the same group, or be an ancestor of the policy's group.

  • Activation. Make a policy version available for use on a given network and across any property in the account. You can only activate shared policies with this API. See the response objects from the List policy activations operation.