Create a service hostname set version

post

https://{hostname}/delivery-manager/v1/workspaces/{workspaceName}/hostname-sets/{hostnameSetName}/versions

This operation creates a new version of a service hostname set. You can modify a version until it's activated. Once you activate a version, you need to create a new one to edit it's settings. Use the reuseVersions=true query parameter to create a new version only when its content does't match an existing version.

Service hostnames are fully qualified domain names (FQDN) that resolve requests from a client to the Akamai edge server and identify traffic rules. You group hostnames into sets to centrally manage shared settings, including certificates, edge hostname assignments, and TLS, for reuse across environments.

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.

hostnameSetName

string

required

Name of the hostname set, unique within a workspace.

Query Params

reuseVersions

boolean

Defaults to true

Whether to re-use an existing resource version. The default true value checks for content parity and only creates a new version if the request content doesn't match an existing one. When false, creates a new version regardless of the request content.

includeCertStatus

boolean

Defaults to false

Whether the response should return the Domain Validation (DV) certificate status from the Certificate Provisioning System (CPS). This applies to service hostnames using certProvisioningType=DEFAULT. Defaults to false.

includeDomStatus

boolean

Defaults to false

Whether the response should return the domain ownership verification status. Defaults to false.

validateHostnames

boolean

Defaults to false

Whether the response should include validation errors and warnings for service hostnames.

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

hostnames

array of objects

required

length ≥ 1

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

hostnames*

certificateConfiguration

object

Certificate-related settings for a service hostname set or individual service hostname overrides. Certificates establish an encrypted, trusted connection between the end user and the Akamai edge, ensuring that data remains private and the authenticity of your application or service is guaranteed.

edgeHostnameConfiguration

object

Edge hostname settings for a service hostname set or individual service hostname overrides. An edge hostname is a DNS-based CNAME target that directs end-user traffic to the nearest or most optimal edge server, rather than your origin server.

hostname

string

required

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.

secureNetwork

string

enum

Specifies the protection level for your service hostnames. ENHANCED_TLS offers high-assurance security for PCI/FedRAMP compliance, supporting custom and older non-SNI clients. STANDARD_TLS provides secure, efficient delivery (ISO/SOX compliant) for general content using SNI. Enhanced TLS is mandatory for high-security sites, while Standard TLS suits general web traffic.

Allowed:

sharedSettings

object

Shared settings define the edge hostnames, TLS standards, and certificate types for the entire service hostname set. Every service hostname in the collection inherits these shared settings automatically.

You can also override these defaults for individual service hostnames within the set. This allows you to customize configurations as needed while maintaining a consistent baseline across your service hostnames.

targetDevTestEnvironments

array of strings

Specifies the environment with the DEVELOPMENT profile where test traffic for a service hostname set version currently routes. A service hostname set can route to many different DEVELOPMENT environments. If the array is empty, this version doesn't route traffic to any DEVELOPMENT environment.

targetDevTestEnvironments

targetEnvironment

string

Specifies the environment with the PRODUCTION profile where live traffic for a service hostname set version currently routes. A service hostname set can only route to one PRODUCTION environment.

201The response shows the new service hostname set version, which you can GET at the URL in the Location header.