{ "opencollection": "1.0.0", "info": { "name": "Akamai: API Endpoint Definition Access tokens Property version hostnames API", "version": "2" }, "items": [ { "info": { "name": "Property version hostnames", "type": "folder" }, "items": [ { "info": { "name": "Akamai List Hostnames for a Property Version", "type": "http" }, "http": { "method": "GET", "url": "https://{hostname}/api-definitions/v2/properties/:propertyId/versions/:propertyVersion/hostnames", "headers": [ { "name": "PAPI-Use-Prefixes", "value": "{{PAPI-Use-Prefixes}}" } ], "params": [ { "name": "propertyId", "value": "{{propertyId}}", "type": "path", "description": "Unique identifier for the property. See [ID prefixes](https://techdocs.akamai.com/property-mgr/reference/id-prefixes) for details on omitting the value's `prp_` prefix." }, { "name": "propertyVersion", "value": "{{propertyVersion}}", "type": "path", "description": "Property's incremental version number." }, { "name": "contractId", "value": "{{contractId}}", "type": "query", "description": "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." }, { "name": "groupId", "value": "{{groupId}}", "type": "query", "description": "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." }, { "name": "validateHostnames", "value": "{{validateHostnames}}", "type": "query", "description": "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." }, { "name": "includeCertStatus", "value": "{{includeCertStatus}}", "type": "query", "description": "__Limited availability__ Whether the response should include the certificate status for the hostname on staging and production networks." }, { "name": "accountSwitchKey", "value": "{{accountSwitchKey}}", "type": "query", "description": "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). The Identity and Access Management API provides a [list of available account switch keys](https://techdocs.akamai.com/iam-api/reference/get-client-account-switch-keys)." } ] }, "docs": "List all hostnames whose requests are handled by the rules in this property version." }, { "info": { "name": "Akamai Update Hostnames for a Property Version", "type": "http" }, "http": { "method": "PUT", "url": "https://{hostname}/api-definitions/v2/properties/:propertyId/versions/:propertyVersion/hostnames", "headers": [ { "name": "If-Match", "value": "{{If-Match}}" }, { "name": "PAPI-Use-Prefixes", "value": "{{PAPI-Use-Prefixes}}" } ], "params": [ { "name": "propertyId", "value": "{{propertyId}}", "type": "path", "description": "Unique identifier for the property. See [ID prefixes](https://techdocs.akamai.com/property-mgr/reference/id-prefixes) for details on omitting the value's `prp_` prefix." }, { "name": "propertyVersion", "value": "{{propertyVersion}}", "type": "path", "description": "Property's incremental version number." }, { "name": "contractId", "value": "{{contractId}}", "type": "query", "description": "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." }, { "name": "groupId", "value": "{{groupId}}", "type": "query", "description": "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." }, { "name": "validateHostnames", "value": "{{validateHostnames}}", "type": "query", "description": "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." }, { "name": "includeCertStatus", "value": "{{includeCertStatus}}", "type": "query", "description": "__Limited availability__ Whether the response should include the certificate status for the hostname on staging and production networks." }, { "name": "accountSwitchKey", "value": "{{accountSwitchKey}}", "type": "query", "description": "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). The Identity and Access Management API provides a [list of available account switch keys](https://techdocs.akamai.com/iam-api/reference/get-client-account-switch-keys)." } ], "body": { "type": "json", "data": "{}" } }, "docs": "Modify the set of hostnames for a property version. For each hostname entry, set headers indicating their [limits](https://techdocs.akamai.com/property-mgr/reference/rate-and-resource-limiting).\n\n**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](https://techdocs.akamai.com/property-mgr/reference/403) error." }, { "info": { "name": "Akamai Add or Remove Hostnames for a Property Version", "type": "http" }, "http": { "method": "PATCH", "url": "https://{hostname}/api-definitions/v2/properties/:propertyId/versions/:propertyVersion/hostnames", "headers": [ { "name": "If-Match", "value": "{{If-Match}}" }, { "name": "PAPI-Use-Prefixes", "value": "{{PAPI-Use-Prefixes}}" } ], "params": [ { "name": "propertyId", "value": "{{propertyId}}", "type": "path", "description": "Unique identifier for the property. See [ID prefixes](https://techdocs.akamai.com/property-mgr/reference/id-prefixes) for details on omitting the value's `prp_` prefix." }, { "name": "propertyVersion", "value": "{{propertyVersion}}", "type": "path", "description": "Property's incremental version number." }, { "name": "contractId", "value": "{{contractId}}", "type": "query", "description": "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." }, { "name": "groupId", "value": "{{groupId}}", "type": "query", "description": "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." }, { "name": "validateHostnames", "value": "{{validateHostnames}}", "type": "query", "description": "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." }, { "name": "includeCertStatus", "value": "{{includeCertStatus}}", "type": "query", "description": "__Limited availability__ Whether the response should include the certificate status for the hostname on staging and production networks." }, { "name": "accountSwitchKey", "value": "{{accountSwitchKey}}", "type": "query", "description": "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). The Identity and Access Management API provides a [list of available account switch keys](https://techdocs.akamai.com/iam-api/reference/get-client-account-switch-keys)." } ], "body": { "type": "json", "data": "{}" } }, "docs": "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 Secure by Default, 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 `remov" } ] } ], "bundled": true }