API

Get started

Review the content here to make sure you're ready to start working with the Cloud Wrapper API.

Start delivering your content

Before you can add a Cloud Wrapper caching footprint to help origin server offload, you need to start delivering your content through the ​Akamai​ network. You do this by creating a delivery configuration ("property") for a supported product, using the Property Manager API (PAPI):

Media delivery

  • Adaptive Media Delivery
  • Download Delivery
  • Object Delivery

Website delivery (Limited Availability)

  • Ion
  • Dynamic Site Accelerator

📘

  • Before you can add Cloud Wrapper, your property needs to be actively delivering your content for 37 days. This helps ​Akamai​ determine your capacity needs.
  • Talk to your account team about access to Cloud Wrapper with website delivery products.

Get Cloud Wrapper on your contract

Make sure Cloud Wrapper is on your contract:

  1. Access ​Akamai Control Center​.

  2. Select ☰ > ACCOUNT ADMIN > Contracts.

  3. Click your Contract ID in the table.

  4. Type cloud in the Filter field:

    • If you see Cloud Wrapper. You're ready to go.

    • If you don't see Cloud Wrapper. Reach out to your ​Akamai​ account team to get it added.

Set up authentication credentials

You use the Identity and Access Management tool in ​Akamai​ ​Control Center​ to set up an API client. This client consists of several values used to authenticate calls to ​Akamai​ APIs.

While you're setting up your API client, do the following:

TaskDescription

Verify you have the API services

In Identity and Access Management, look for the API client for you interface. Click Show additional details, look for these entries in the APIs table:

  • Cloud Wrapper. This product's API. You'll use it to create and manage your Cloud Wrapper configurations. Make sure its access level is set to READ-WRITE.

  • Property Manager. Called PAPI for short, this API lets you create and manage the properties you use to deliver your content.

If you don't see them, or they're set to the wrong access level, talk to your company's ​Akamai​ administrator to get your user updated. You can also reach out to your ​Akamai​ account team for assistance.

Gather values

In the Credentials section, make note of the client_secret, host, access_token, and client_token values.

🚧

The client_secret is only revealed once

This value is only revealed after you first create an API client. You can't come back to this interface to get it. So, make sure you make note of it for use. You can use the Download or Copy credential buttons in the interface to save all of your values.

Get your identifiers

You need some specific identifiers for various operations in the API.

1. Get your contractId

This applies to the contract that includes the Cloud Wrapper product. You can find your contractId using the Property Manager API:

PAPI: List contracts
Open Recipe

If you only have one, store its contractId. If you have more than one, note each of them and run individual instances of this operation with each contractId:

PAPI: List products
Open Recipe

2. Get your groupId

You use a specific "user" to create the objects that make up your delivery workflow. Objects include a property to deliver your content and your Cloud Wrapper configuration to specify your cache footprint. Your user belongs to a specific group within your contract. You need this group's unique identifier to call APIs:

PAPI: List groups
Open Recipe

📘

When you run the PAPI-specific operations, the response will show these values, prefaced by their PAPI prefixes—ctr_<value> and grp_<value>, respectively. The following apply:

  • PAPI. When using these IDs with a PAPI operation, you need to include the prefixes.
  • Cloud Wrapper. When using these IDs with any other API's operations, you need to remove the prefixes.

Know the workflow

There are several things you can do with the Cloud Wrapper API, key among them is creating a Cloud Wrapper configuration. Here are the basic steps to get this done:

1. Set up a property

As covered earlier, you need a property actively delivering your media or website content through the ​Akamai​ network.

2. Determine your capacity

Work with your ​Akamai​ account team to determine your capacity needs and add that capacity to your contract.

📘

Cloud Wrapper has a default object limit of 10,000 objects/GB.

3. Create and activate your Cloud Wrapper configuration

This is the amount of cache space you're allocating in a specific geographic region.

4. Add the Cloud Wrapper behavior to your property

Use PAPI to add this behavior to enable it in your property. Select a location you've established in your Cloud Wrapper configuration to use its cache space.

  • Get a configuration. Run this operation using the id you stored to verify that its activation status is ACTIVE.

  • Add the behavior. Get the cloudWrapper behavior added to your property rule tree.

5. Configure your origin server

Use PAPI once again to configure the origin behavior in your property to set up the origin server where your deliverable content lives. Cloud Wrapper leverages this information to get your content and store it in its cache.