Create an activation

post

https://{hostname}/delivery-manager/v1/workspaces/{workspaceName}/activations

This operation deploys the specified environment and service hostname set versions to either AKAMAI_STAGING for an isolated test network that mirrors the final deployment, or AKAMAI_PRODUCTION for the public-facing network, handling live traffic for your edge service. Once active, the service hostname sets route traffic to the edge servers running the environment version, which contains the configuration for your application or service. To monitor the activation's asynchronous process, GET the URL provided in the Location header.

Path Params

workspaceName

string

required

Name of the workspace that unifies all resources for your application or service. You can rename the workspace with a separate operation after you initially create the resource.

Query Params

pauseBeforeActivating

boolean

Defaults to false

Indicates whether the activation should pause after validation. This allows you to review validation results and activation summary while the activation is in the STAGED state. You can then resume the activation. When false, the activation proceeds immediately after a successful validation.

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 an activation request. The activation target can be an environment version, service hostname set versions, or both. The type determines which target fields apply.

environment

object

required

An environment is a variant of an application or service in a given lifecycle stage, such as development, testing, or production. You create versions to experiment with rule settings and iterate without affecting other environments. Environment versions isolate different settings for your service until you explicitly promote them to production. Each environment version maintains its own change history of rule sets.

hostnameSets

array of objects

length ≥ 1

Lists service hostnames within a set that share the same edge hostname, TLS, and certificate settings.

hostnameSets

network

string

enum

required

The network you activate on, either AKAMAI_STAGING for an isolated test network that mirrors the final deployment, or AKAMAI_PRODUCTION for the public-facing network, handling live traffic for your application or service. AKAMAI_DEVELOPMENT only applies to activations of environments with the DEVELOPMENT profile.

Allowed:

note

string

A descriptive log comment.

notifyEmails

array of strings

Email addresses to notify when the activation status changes.

notifyEmails

type

string

enum

required

Specifies the scope of the activation or deactivation operation.

Show details on supported values

ACTIVATE_ENVIRONMENT. Activates the environment version only.
ACTIVATE_HOSTNAME_SETS. Activates service hostname set versions only against the routed environment's currently active version.
ACTIVATE_ENVIRONMENT_AND_HOSTNAME_SETS. Activates both the environment version and one or more service hostname set versions together.
DEACTIVATE_ENVIRONMENT. Deactivates the environment version only.
DEACTIVATE_HOSTNAME_SETS. Deactivates service hostname set versions only, leaving the routed environment version active.
DEACTIVATE_ENVIRONMENT_AND_HOSTNAME_SETS. Deactivates both the environment and all related active service hostname sets together.

Allowed:

Response

201The response shows the new activation, which you can GET at the URL in the Location header.