Get a custom override

get

https://{hostname}/papi/v1/custom-overrides/{overrideId}

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

Responses

Response body

object

accountId

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

description

string

required

Description for the custom override.

displayName

string

required

Display label for the custom override.

name

string

required

Name for the custom override.

overrideId

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.

status

string

enum

required

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

ACTIVE

updatedByUser

string

required

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

updatedDate

string

required

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

xml

string

The customized XML metadata to append to the rule tree.

Headers

object

X-RateLimit-Limit

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.

X-RateLimit-Remaining

integer

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

Language

Authentication

Remember to add your authentication credentials to run this code.

URL


xxxxxxxxxx
1
curl --request GET \
2
     --url https://hostname/papi/v1/custom-overrides/overrideId \
# Add Authorization header to this snippet
3
     --header 'PAPI-Use-Prefixes: true' \
4
     --header 'accept: application/json'


xxxxxxxxxx
17
 
1
{
2
  "accountId": "act_A-CCT5678",
3
  "customOverrides": {
4
    "items": [
5
      {
6
        "description": "Multiple Domain Configuration can be used to ...",
7
        "displayName": "MDC Behavior",
8
        "name": "mdc",
9
        "overrideId": "cbo_12345",
10
        "status": "ACTIVE",
11
        "updatedByUser": "jsmith",
12
        "updatedDate": "2017-04-24T12:34:56Z",
13
        "xml": "<comment:info>This is where the XML goes</comment:info>"
14
      }
15
    ]
16
  }
17
}

200The response shows the specified custom override.

400Bad request.

401Unauthorized.

403Forbidden.

404Not found.

405Method not allowed.

406Not acceptable.

429Too many requests.

500Internal server error.