List available hostnames for a new configuration

All products Lists the hostnames for a given contract and group. Use this operation for a new configuration, and use List selectable hostnames to see a list of hostnames you can add to an existing configuration. This operation shows you every acceptable hostname you can use, where the other hostname operation omits any hostnames already included in your configuration.

Path Params
string
required

A unique identifier for a group.

string
required

A unique identifier for a contract.

Query Params
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.

Responses

Response body
object
availableSet
array of objects

The available hosts set for the current user.

availableSet
object
boolean

Whether the hostname is active in the production network.

boolean

Whether the hostname is active in the staging network.

boolean

Whether the hostname is Akamai Resource Locator (ARL) included.

integer | null

Uniquely identifies the configuration that protects the hostname.

string | null

The name of the configuration that protects the hostname.

string
required

The hostname.

integer
required

Uniquely identifies the security configuration.

integer
required

The security configuration version.

errorSet
array of objects

The requested hosts aren't available in this configuration version.

errorSet
object
string
required

The hostname that triggers an error.

string
required

The reason why the hosts aren't protectable in this configuration version.

integer
required

The error status code for the hostname.

boolean
required

Whether the host defined in the ARL file has legacy WAF enabled in the configuration.

selectedSet
array of objects

The selected set of hostnames in this configuration version.

selectedSet
object
boolean

Whether the hostname is active in the production network.

boolean

Whether the hostname is active in the staging network.

boolean

Whether the hostname is Akamai Resource Locator (ARL) included.

integer | null

Uniquely identifies the configuration that protects the hostname.

string | null

The name of the configuration that protects the hostname.

string
required

The hostname.

Language
Authentication
URL