{ "opencollection": "1.0.0", "info": { "name": "Akamai: API Endpoint Definition Access tokens Contracts and groups API", "version": "2" }, "items": [ { "info": { "name": "Contracts and groups", "type": "folder" }, "items": [ { "info": { "name": "List contracts and groups", "type": "http" }, "http": { "method": "GET", "url": "https://{hostname}/api-definitions/v2/contracts/groups", "params": [ { "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": "You provision each API endpoint within the context of your contract with Akamai and a Control Center portal group. The response objects encapsulate pairings of contract and group identifiers available within the scope of the user who provisioned the API token, as described in [Get started](https://techdocs.akamai.com/api-definitions/reference/api-get-started)." }, { "info": { "name": "List hostnames", "type": "http" }, "http": { "method": "GET", "url": "https://{hostname}/api-definitions/v2/contracts/:contractId/groups/:groupId/hosts", "params": [ { "name": "groupId", "value": "{{groupId}}", "type": "path", "description": "The unique identifier for the group." }, { "name": "contractId", "value": "{{contractId}}", "type": "path", "description": "The unique identifier for the contract." }, { "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": "Lists all hostnames through which API consumers can access an endpoint service under a given contract and group pairing. You can use Property Manager (or [PAPI](https://techdocs.akamai.com/property-mgr/reference/api)) to create new hostnames to make available to users." }, { "info": { "name": "List hostnames with access control groups", "type": "http" }, "http": { "method": "GET", "url": "https://{hostname}/api-definitions/v2/contracts/:contractId/groups/:groupId/hostsAcgs", "params": [ { "name": "groupId", "value": "{{groupId}}", "type": "path", "description": "The unique identifier for the group." }, { "name": "contractId", "value": "{{contractId}}", "type": "path", "description": "The unique identifier for the contract." }, { "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": "Lists all hostnames through which API consumers can access an endpoint service under a given contract and group pairing. Returns each hostname together with the access control group where the hostname is registered. You can use Property Manager (or [PAPI](https://techdocs.akamai.com/property-mgr/reference/api)) to create new hostnames to make available to users." }, { "info": { "name": "List contracts and groups", "type": "http" }, "http": { "method": "GET", "url": "https://{hostname}/api-definitions/v2/contracts-groups", "params": [ { "name": "accountSwitchKey", "value": "", "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": "__All products__ List the contracts and groups for your account. Each object contains the contract, groups associated with the contract, and whether Kona Site Defender or Web Application Protector is the product for that contract. You'll need this information when you create a new security configuration or when you want to get a list of hostnames still available for use in a security policy." } ] } ], "bundled": true }