Create a configuration

post

https://{hostname}/cloud-wrapper/v1/configurations

Create a Cloud Wrapper configuration.

📘
You first need to work with your account team to include Cloud Wrapper locations and capacity on your contract. Verify your capacity by viewing your capacity inventory.

Query Params

activate

boolean

Defaults to false

Specify if you want to activate the modified configuration, false by default. Otherwise, you can run the Activate a configuration operation separately.

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

Creates a Cloud Wrapper configuration.

capacityAlertsThreshold

int64 | null

50 to 100

Represents the threshold for sending alerts. Displayed as null if you haven't enabled capacity alerts.

comments

string

required

length between 1 and 255

Additional information you provide to differentiate or track changes of the configuration.

configName

string

required

length between 4 and 20

The name of the configuration (property) you've set up to deliver your content. This is the propertyName you set when you create the property.

contractId

string

required

length between 0 and 20

The unique identifier Akamai assigned to your contract, where you've added Cloud Wrapper.

locations

array of objects

required

length between 1 and 2147483647

Compatible locations you can use with the configuration. Locations need to have a pre-approved capacity approval for the selected contract.

locations*

Location configuration that describes property and traffic type.

capacity

object

required

The capacity assigned to this configuration's location. List capacity to view the approvedCapacity and assignedCapacity values.

comments

string

required

length between 1 and 255

Additional information provided when creating the property.

trafficTypeId

int64

required

0 to 1000

The unique identifier for the location and traffic type combination. You can list locations to see your available combinations.

multiCdnSettings

object | null

Specify details about the Multi CDN settings. Displayed as null if Multi CDN isn't defined in your Cloud Wrapper configuration.

notificationEmails

array of strings

length ≥ 0

Email addresses to receive notifications.

notificationEmails

propertyIds

array of strings

required

length ≥ 1

The identifiers that represent the properties eligible to add Cloud Wrapper. To see property specifics, run the list properties operation.

propertyIds*

retainIdleObjects

boolean

Defaults to false

By default, idle objects are kept in your footprint for 30 days. Set to true, your configuration retains them beyond this 30 day limit. This only applies to locations you've configured with a redundant content type like LIVE_VOD or WEB_OPTIMIZED.

Headers

string

enum

Defaults to application/json

Generated from available response content types

Allowed:

Responses

Language

URL

Loading…

Response

Click Try It! to start a request and see the response here! Or choose an example:

application/json

application/problem+json

201The response provides the new configuration.

400Bad request. You provided bad parameter data or formatted the request body incorrectly.

401Unauthorized. A value in your authentication credential is invalid or it's expired.

403Access forbidden. You lack permission for this operation, such as having read-only access.

404Not found. You've input the API URL incorrectly or named an asset that doesn't exist.

405Not allowed. You used an unsupported method with this operation. For example, you set the method to PUT for a GET operation.

415Unsupported media type. You've used an unsupported request or response content type, such as application/xml. Try the operation again using application/json.

500Internal server error. An internal error occurred. Try the request again. If the error continues, contact your account team.