Akamai APIs API Documentation
List use cases
GET https://{{host}}/papi/v1/products/:productId/mapping-use-cases?contractId={{contractId}}
For a given product, this lists Akamai-provided use case scenarios. Use cases help optimally map different types of traffic across the Akamai edge network. Optionally run this operation to gather values before creating a new edge hostname.
Body
PARAM
| Key | Datatype | Required | Description |
contractId
|
string | (Required) 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. | |
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). 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). |
HEADERS
| Key | Datatype | Required | Description |
PAPI-Use-Prefixes
|
string | (Required) __Enum__ Sets whether to represent [ID prefixes](https://techdocs.akamai.com/property-mgr/reference/id-prefixes) in response data. Set to `false` when exchanging PAPI data with other APIs. | |
Accept
|
string |
RESPONSES
status OK
| {
"useCases": [
{
"options": [
"BACKGROUND",
"FOREGROUND"
],
"type": "GLOBAL",
"useCase": "Download_Mode"
}
]
} |
Curl
curl -X GET 'https://host/papi/v1/products/:productId/mapping-use-cases?contractId=?contractId=&accountSwitchKey=' -H 'PAPI-Use-Prefixes: PAPI-Use-Prefixes' -H 'Accept: application/json'
ENDPOINTS