{ "opencollection": "1.0.0", "info": { "name": "Akamai: API Endpoint Definition Access tokens Hostname buckets API", "version": "2" }, "items": [ { "info": { "name": "Hostname buckets", "type": "folder" }, "items": [ { "info": { "name": "Akamai List Property Hostname Activations", "type": "http" }, "http": { "method": "GET", "url": "https://{hostname}/api-definitions/v2/properties/:propertyId/hostname-activations", "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": "offset", "value": "{{offset}}", "type": "query", "description": "For paginated responses, specifies the page of results you want to navigate to, starting from `0`." }, { "name": "limit", "value": "{{limit}}", "type": "query", "description": "For paginated responses, specifies the number of `hostnames` objects to include on each page." }, { "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": "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": "For a property with `useHostnameBucket` set to `true` at [creation](https://techdocs.akamai.com/property-mgr/reference/post-properties), this lists the activations for all hostnames in the property's hostname bucket, on both production and staging networks. To view paginated results, use the response's `nextLink` and `previousLink`." }, { "info": { "name": "Akamai Get a Property Hostname Activation", "type": "http" }, "http": { "method": "GET", "url": "https://{hostname}/api-definitions/v2/properties/:propertyId/hostname-activations/:hostnameActivationId", "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": "hostnameActivationId", "value": "{{hostnameActivationId}}", "type": "path", "description": "Unique identifier for the hostname activation." }, { "name": "includeHostnames", "value": "{{includeHostnames}}", "type": "query", "description": "Whether the response should include the property hostnames associated with an activation and the related certificate status on staging and production networks." }, { "name": "contractId", "value": "{{contractId}}", "type": "query", "description": "Unique identifier for the contract. 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. See [ID prefixes](https://techdocs.akamai.com/property-mgr/reference/id-prefixes) for details on omitting the value's `grp_` prefix." }, { "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": "For a property with `useHostnameBucket` set to `true` at [creation](https://techdocs.akamai.com/property-mgr/reference/post-properties), this operation gets details about a specific property hostname activation. You typically get a single activation from an `activationLink` when [launching a new property hostname activation](https://techdocs.akamai.com/property-mgr/reference/patch-property-hostnames) and following up to poll its `status`. For property hostname activations whose `status` is `PEND" }, { "info": { "name": "Akamai Cancel a Pending Property Hostname Activation", "type": "http" }, "http": { "method": "DELETE", "url": "https://{hostname}/api-definitions/v2/properties/:propertyId/hostname-activations/:hostnameActivationId", "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": "hostnameActivationId", "value": "{{hostnameActivationId}}", "type": "path", "description": "Unique identifier for the hostname activation." }, { "name": "contractId", "value": "{{contractId}}", "type": "query", "description": "Unique identifier for the contract. 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. See [ID prefixes](https://techdocs.akamai.com/property-mgr/reference/id-prefixes) for details on omitting the value's `grp_` prefix." }, { "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": "For a property with `useHostnameBucket` set to `true` [when created](https://techdocs.akamai.com/property-mgr/reference/post-properties), if you detect a problem with a property hostname while its activation is still `PENDING`, use this operation to cancel it. Make a DELETE request on the `activationLink` you get from the [Add or remove hostnames for a property](https://techdocs.akamai.com/property-mgr/reference/patch-property-hostnames) operation's response. Once you DELETE the activation, it n" }, { "info": { "name": "Akamai Add or Remove Hostnames for a Property's Hostname Bucket", "type": "http" }, "http": { "method": "PATCH", "url": "https://{hostname}/api-definitions/v2/properties/:propertyId/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": "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": "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": "For a property with `useHostnameBucket` set to `true` [when created](https://techdocs.akamai.com/property-mgr/reference/post-properties), this operation adds or removes up to 1000 property hostnames without incrementing the property version. Changes automatically activate on the selected network. If a property doesn't have hostname buckets enabled, this operation returns a [403](https://techdocs.akamai.com/property-mgr/reference/403) error. If another activation is in progress, whether it's a ho" } ] } ], "bundled": true }