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.

Request Params

KeyDatatypeRequiredDescription
contractIdstring(Required) Unique identifier for the contract. See ID prefixes for details on omitting the value's ctr_ prefix.
accountSwitchKeystring(Optional) For customers who manage more than one account, this runs the operation from another account. The Identity and Access Management API provides a list of available account switch keys.

HEADERS

KeyDatatypeRequiredDescription
PAPI-Use-Prefixesstring(Required) Enum Sets whether to represent ID prefixes in response data. Set to false when exchanging PAPI data with other APIs.
Acceptstring

RESPONSES

status: OK

{"useCases":[{"options":["BACKGROUND","FOREGROUND"],"type":"GLOBAL","useCase":"Download_Mode"}]}