Update hostnames for a property version

Modify the set of hostnames for a property version. For each hostname entry, set headers indicating their limits.

Note: If you're using a new account, first register it on the Akamai network by activating any property version on either staging or production. Otherwise, your attempts to create or specify certificates will fail with a 403 error.

Recipes
Update a property with a Default DV certificate hostname
Open Recipe
Update a property with a CPS-managed certificate hostname
Open Recipe
Update a property with a shared certificate hostname
Open Recipe
Path Params
string
required

Unique identifier for the property. See ID prefixes for details on omitting the value's prp_ prefix.

integer
required

Property's incremental version number.

Query Params
string

Unique identifier for the contract. The parameter is optional if a property belongs to only one contract. Otherwise you need to specify it along with the groupId. In other operations that don't specify a propertyId URL parameter, this parameter is always required. See ID prefixes for details on omitting the value's ctr_ prefix.

string

Unique identifier for the group. The parameter is optional if a property belongs to only one group. Otherwise you need to specify it along with the contractId. In other operations that don't specify a propertyId URL parameter, this parameter is always required. See ID prefixes for details on omitting the value's grp_ prefix.

boolean
Defaults to false

When false, skips validation tests that would identify potential hostname-related problems within the response object's errors and warnings arrays. See Property hostname errors for details on relevant error feedback. See Validation best practices for guidance on when to defer validation.

boolean
Defaults to false

Limited availability Whether the response should include the certificate status for the hostname on staging and production networks.

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
Headers
string
required

This corresponds to the ETag response header. Passing this value back as If-Match in write requests ensures you don't overwrite edits by any other API clients. See Concurrency control for details.

string
required

Enum Sets whether to represent ID prefixes in response data. Set to false when exchanging PAPI data with other APIs.

Responses

Response body
object
string

Identifies the prevailing account under which you requested the data. See ID prefixes for details on how to omit the ID's act_ prefix.

string

Identifies the prevailing contract under which you requested the data. See ID prefixes for details on how to omit the ID's ctr_ prefix.

string

A digest with which to check the data's integrity. See Concurrency control for guidance.

string

Identifies the prevailing group under which you requested the data. See ID prefixes for details on how to omit the ID's grp_ prefix.

hostnames
object

The set of requested property hostnames, available within an items array.

items
array of objects

Each entry specifies a property hostname that's assigned to the requested property version. Writing data to this resource requires that you PUT an array of all the hostname objects, each containing edgeHostnameId, cnameFrom, and cnameTo members. This request array matches the hostnames.items in the response.

items
object
string
required
Defaults to CPS_MANAGED

Indicates the certificate's provisioning type. Either CPS_MANAGED type for the certificates you create with the Certificate Provisioning System API (CPS), or DEFAULT for the Default Domain Validation (DV) certificates created automatically. Note that you can't specify the DEFAULT value if your property hostname uses the akamaized.net domain suffix.

Warning: If you don't specify this field on PUT or PATCH, PAPI automatically sets the value to CPS_MANAGED, which may override your previous selections.

CPS_MANAGED DEFAULT

certStatus
object

Limited availability With the includeCertStatus parameter set to true, determines whether a hostname is capable of serving secure content over the staging or production network.

string
required

The hostname that your end users see, indicated by the Host header in end user requests.

string

The edge hostname you point the property hostname to so that you can start serving traffic through Akamai servers. This member corresponds to the edge hostname object's edgeHostnameDomain member.

string
required

Only one supported EDGE_HOSTNAME value.

EDGE_HOSTNAME

string
required

Identifies each edge hostname. See ID prefixes for details on how to omit the ID's ehn_ prefix.

string

Identifies the property this set of hostnames represents. See ID prefixes for details on how to omit the ID's prp_ prefix. Don't use this value if you want to exchange data with the Identity and Access Manager API. See Manage properties and includes.

string

A unique, descriptive name for the property. It's not modifiable after you initially create it on a POST request.

integer
≥ 1

The version of the property this set of hostnames represents.

Headers
object
string

Pass the ETag response header back as If-Match in write requests to ensure you don't overwrite edits by any other API clients. See Concurrency control for details.

string

The total number of Default Domain Validation (DV) certificates per contract. This header only appears if you have any hostnames with Default DV certificates assigned to the property version.

string

The number of remaining Default Domain Validation (DV) certificates per contract. This header only appears if you have any hostnames with Default DV certificates assigned to the property version.

string

Maximum number of hostnames you can assign to a property configuration.

string

Remaining number of hostnames you can assign to a property configuration. See Rate and resource limiting for details.

integer

Maximum sustainable number of request allowed each minute per account. This rate limit protects PAPI resources from being exhausted by single users. Once you exceed the limit, you receive the 429 error. If you call PAPI using multiple API clients within the same account, the rate limit applies globally to all API clients.

This API also provides a burst limit that specifies how many requests you can make in excess of the imposed rate limit. The one-time burst limit is 1000 requests. Once you consume all available resources, the burst capacity increases steadily by 100 requests every minute, until it reaches its initial maximum limit of 1000.

integer

Remaining number of requests allowed each minute per account. See Rate and resource limiting for details.

Language
Authentication
URL