Quickstart

post

https://{hostname}/delivery-manager/v1/workspace-onboarding

Creates a foundational delivery architecture in a single batch request, including a workspace, production environment, routed service hostname set, and corresponding edge hostnames.

Applied defaults

Shared service hostname settings: Sets secureNetwork to STANDARD_TLS, certProvisioningType to DEFAULT.
Automated edge hostname generation: Automatically generates a unique edge hostname for each service hostname in the set using the PER_HOSTNAME pattern with IPV6_IPV4_DUALSTACK IP version behavior. The resulting edge hostnames are created based on the service hostname prefix and the shared suffix, forming a CNAME like www.example.com.edgesuite.net. This provides granular domain isolation and traffic control without duplicating shared infrastructure settings.

The response includes tokens for domain ownership and certificate validation. Once you complete domain validation, the setup is ready for activation on the Akamai edge network.

Query Params

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

contractId

string

required

Write-once Unique identifier for the contract, linking to billing or licensing agreements.

defaultGroupId

string

required

^[0-9]+$

A unique identifier for a group that controls access to workspace components. You configure groups in Identity and Access Management.

environmentName

string

required

length ≤ 255

^[a-z][a-z0-9._-]+$

Name of the environment that uniquely identifies it within a workspace.

hostnameSetName

string

length ≤ 255

^[a-z][a-z0-9._-]+$

Name of the service hostname set that uniquely identifies it within a workspace.

originHostname

string

Specifies the address edge servers use to pull your content from your backend servers.

productId

string

required

Write-once Unique identifier for each Akamai product.

serviceHostnames

array of strings

Lists service hostnames within a set that share the same edge hostname, TLS, and certificate settings. A service hostname is a fully qualified domain name (FQDN) that resolves requests from a client to the Akamai edge server and identifies traffic rules.

serviceHostnames

workspaceName

string

required

length ≤ 255

^[a-z][a-z0-9._-]+$

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.

Response

202The response shows that the batch job initiated. To check its status or view the results once it completes, GET the URL in the Location header.