Add or remove hostnames for a property version

patch

https://{hostname}/papi/v1/properties/{propertyId}/versions/{propertyVersion}/hostnames

Modify the set of hostnames for a property version. For new entries, specify an add array with a cnameFrom set to the hostname your end users see as Host headers. In either cnameTo or edgeHostnameId, specify an existing edge hostname you want to redirect your hostname to. If you're using Default Domain Validation (DV) certificates, you can set the cnameTo to an edge hostname that doesn't exist yet, and PAPI creates it automatically when you activate the property version. To remove a hostname, specify a remove array with the address of the hostname you don't want to use with this property version anymore. If you remove an edge hostname from an active property configuration, use the Edge Hostname API (HAPI) to delete it entirely. If you modify hostnames with Default DV certificates, the response includes additional X-Limit-Default-Certs-Per-Contract-Limit and X-Limit-Default-Certs-Per-Contract-Remaining headers indicating their limits.

If your account is enabled for mandatory domain validation, you need to prove ownership of the domains you set up as property hostnames, before activating the property. You can either pre-validate your domains by generating validation challenges or use the challenges you get while adding, listing, or updating your property version hostnames. Learn more.

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.

Path Params

propertyId

string

required

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

propertyVersion

integer

required

Property's incremental version number.

Query Params

contractId

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.

groupId

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.

validateHostnames

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.

includeCertStatus

boolean

Defaults to false

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

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

Updates the set of property hostnames that apply to a property version. You delete each hostname by specifying its string value. For additions, you need to specify a fuller object.

add

array of objects

length ≥ 0

Adds new hostnames to a property version's current set of hostnames.

add

remove

array of strings

length ≥ 0

Removes property hostnames from a property version's current set of hostnames.

remove

Headers

If-Match

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.

PAPI-Use-Prefixes

string

enum

required

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

Allowed:

string

enum

Defaults to application/json

Generated from available response content types

Allowed:

Responses

200The response lists the property version's updated set of hostnames.

400Bad request.

401Unauthorized.

403Forbidden.

404Not found.

405Method not allowed.

406Not acceptable.

412Precondition failed.

415Unsupported media type.

429Too many requests.

500Internal server error.