{ "opencollection": "1.0.0", "info": { "name": "Akamai: API Endpoint Definition Access tokens Active property hostnames API", "version": "2" }, "items": [ { "info": { "name": "Active property hostnames", "type": "folder" }, "items": [ { "info": { "name": "Akamai List Hostnames for a Property", "type": "http" }, "http": { "method": "GET", "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": "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": "sort", "value": "{{sort}}", "type": "query", "description": "__Enum__ Sort the results based on the `cnameFrom` value, either `hostname:a` for ascending or `hostname:d` for descending order. The default is `hostname:a`." }, { "name": "hostname", "value": "{{hostname}}", "type": "query", "description": "Filter the results by `cnameFrom`. Supports wildcard matches with `*`." }, { "name": "cnameTo", "value": "{{cnameTo}}", "type": "query", "description": "Filter the results by edge hostname. Supports wildcard matches with `*`." }, { "name": "network", "value": "{{network}}", "type": "query", "description": "__Enum__ Network of activated hostnames, either `STAGING` or `PRODUCTION`." }, { "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": "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": "This operation lists active property hostnames assigned to a specific property. Use the optional query parameters to paginate, sort, and filter the results. You can nest and combine filters to obtain desired results. To view paginated results, use the response's `nextLink` and `previousLink`. You can call this operation by specifying any of the `propertyId` members from a [list of properties](https://techdocs.akamai.com/property-mgr/reference/get-properties), or by running a GET on the `property" }, { "info": { "name": "Akamai Get Property Hostnames Diff", "type": "http" }, "http": { "method": "GET", "url": "https://{hostname}/api-definitions/v2/properties/:propertyId/hostnames/diff", "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": "This operation lists active property hostnames whose details differ between the staging and production networks. Optionally paginate the results. You can run this operation by specifying any of the `propertyId` members from a [list of properties](https://techdocs.akamai.com/property-mgr/reference/get-properties), or by running a GET on the `propertyLink` response when [creating a new property](https://techdocs.akamai.com/property-mgr/reference/post-properties)." } ] } ], "bundled": true }