Add or remove hostnames for a property version
PATCH https://{{host}}/papi/v1/properties/:propertyId/versions/:propertyVersion/hostnames
Modify the set of hostnames for a property version. For new entries, specify an 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.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.
Body
PARAM
| Key | Datatype | Required | Description |
contractId
|
string | (Optional) 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](https://techdocs.akamai.com/property-mgr/reference/id-prefixes) for details on omitting the value's `ctr_` prefix. | |
groupId
|
string | (Optional) 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](https://techdocs.akamai.com/property-mgr/reference/id-prefixes) for details on omitting the value's `grp_` prefix. | |
validateHostnames
|
string | (Optional) 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](https://techdocs.akamai.com/property-mgr/reference/validation-errors) for details on relevant error feedback. See [Validation best practices](https://techdocs.akamai.com/property-mgr/reference/validation-best-practices) for guidance on when to defer validation. | |
includeCertStatus
|
string | (Optional) __Limited availability__ Whether the response should include the certificate status for the hostname on staging and production networks. | |
accountSwitchKey
|
string | (Optional) For customers who manage more than one account, this [runs the operation from another account](https://techdocs.akamai.com/developer/docs/manage-many-accounts-with-one-api-client). Curl curl -X PATCH 'https://host/papi/v1/properties/:propertyId/versions/:propertyVersion/hostnames?contractId=&groupId=&validateHostnames=&includeCertStatus=&accountSwitchKey=' -H 'If-Match: If-Match' -H 'PAPI-Use-Prefixes: PAPI-Use-Prefixes' -H 'Content-Type: application/json' -H 'Accept: application/json' -d '{"add":[{"cnameFrom":"m.example.com","cnameTo":"example.com.edgesuite.net","cnameType":"EDGE_HOSTNAME"},{"cnameFrom":"example3.com","cnameType":"EDGE_HOSTNAME","edgeHostnameId":"ehn_895824"}],"remove":["m.example.com","example4.com"]}' ENDPOINTS |