Get a custom override

Get information for a single custom override. Use this operation if you want to examine the override's XML metadata.

Path Params
string
required

Unique identifier for the custom override.

Query Params
string

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
string
required

Enum Sets whether to represent ID prefixes in response data. Set to false when exchanging PAPI data with other APIs.

Responses

Response body
object
string
length ≥ 1

The account under which this custom overrride is available.

customOverrides
object

The set of requested custom overrides, available within an items array.

items
array of objects

Represents a customized XML metadata Akamai sets up on your behalf. You can invoke it in a customOverride object within the top-level default rule tree to make it execute after all other rules, typically to restore a desired state. Relevant response objects appear within the outer envelope's customOverrides.items array. See Custom behaviors and overrides for guidance on custom overrides.

items
object
string
required

Description for the custom override.

string
required

Display label for the custom override.

string
required

Name for the custom override.

string
required

The unique identifier for the custom XML override that you reference from a customOverride object to append it to a rule tree. See ID prefixes for details on how to omit the ID's cbo_ prefix.

string
required

Current deployment status for the custom override. By the time it's available to customers, the only possible value is ACTIVE.

ACTIVE

string
required

The name of the Akamai representative who last updated the custom override.

string
required

The date stamp of the custom metadata's latest update.

string

The customized XML metadata to append to the rule tree.

Headers
object
integer

Maximum sustainable number of request allowed each minute per account. This rate limit protects PAPI resources from being exhausted by single users. Once you exceed the limit, you receive the 429 error. If you call PAPI using multiple API clients within the same account, the rate limit applies globally to all API clients.

This API also provides a burst limit that specifies how many requests you can make in excess of the imposed rate limit. The one-time burst limit is 1000 requests. Once you consume all available resources, the burst capacity increases steadily by 100 requests every minute, until it reaches its initial maximum limit of 1000.

integer

Remianing number of requests allowed each minute per account. See Rate and resource limiting for details.

Language
Authentication
URL