The Content Control Utility API

The Content Control Utility (CCU) API provides a programmatic interface for you to purge edge content. In this version, you can purge by URL, by Content Provider (CP) code, or cache tag.

For users of the legacy Content Control Utility REST API, this API leverages the Fast Purge Utility via Luna authentication. The Luna Control Center provides a graphical interface to the Fast Purge Utility for content administrators.

This guide details the most recent version 3 of the CCU API, which uses Fast Purge versus queue-based processing. For queue-based processing, see the Content Control Utility API v2.

For more information about Fast Purge, see CCU API Concepts.

Who Should Use This API

The CCU API is a simple API that automates content purge requests. Support for Fast Purge in the current version allows developers and architects to purge edge content by URL, CP code, or cache tag within approximately five seconds.

For more information on content control using TTL (Time to Live) methods, refer to Time to Live (TTL) in Cache: Methods and Considerations.

Getting Started

To get started with this API:

  • Review the API Introduction section on available tools.

  • Review API Provisioning to create your API access credentials and authorizations. When creating, adding, and naming clients for API access, do so under CCU APIs, not Luna APIs. Note that you can select all CP codes when configuring your API credentials. This means all current and future CP codes on the current contract, not all CP codes on the account.

  • Get help from our developer community or Technical Support, and provide feedback. You can also contact your account representative for support. We want to hear from you!

CCU API Concepts

This section describes the conceptual objects you deal with when interacting with this API, and provides pointers to where you can learn more.

  • Fast Purge: The Fast Purge utility completes purge requests within approximately five seconds. Fast Purge supports requests to invalidate or delete URLs and CP codes on Akamai Staging and Production networks. It will eventually support all purge methods.

  • Invalidation: Content invalidation, or refresh request, is the default purge action in most cases. An invalidation purge action causes Akamai edge servers to send an If-Modified-Since (IMS) request to the origin on subsequent requests for invalidated content. If the timestamp of the object at the origin is more recent than the one in cache, the latter is replaced by the new object from the origin. Otherwise, it is re-validated for the duration of the TTL. If an object does not have a Last-Modified header, a regular GET request is sent to origin.

    NOTE: To avoid serving stale content, ensure the Last-Modified-Timestamp (LMT) value on the origin server is updated to a newer timestamp than the LMT value of the current object.

  • Deletion: The purge action that removes the object from cache so that it is no longer available to be served to clients.Deletion operations result in an expensive GET request to the origin server, and prevents Akamai from serving this content stale if the origin server is down.

  • Content Provider (CP) Code: A CP code identifies a set, typically a subset, of content on your origin server. CP codes also provide additional granularity in reports and to track billing. Each contract has at least one CP code associated with it. You cannot apply the same CP code to content under more than one contract. If you are using Property Manager, see the Property Manager API (PAPI) to retrieve a list of CP codes available for a selected contract and group. PAPI also allows you to generate new CP codes, assign them to properties, and apply them within property rules.

  • Cache Key: The cache key is an index entry for an object in cache. By default, Akamai uses the entire uniform resource identifier (URI) and query string to identify cached objects. You can specify a custom cache key to cache different versions of an object based on differences in query parameters and other differences such as variations in device characteristics..

  • Cache Tag: An opaque label applied to content from the origin by way of the Edge-Cache-Tag header. Once a set of objects have been cached with a tag, they can be purged together with a single version 3 API call. You can apply many tags to any object, allowing you to purge by any overlapping set of classifications you define, such as black-friday, flash-sale, electronics, laptops, tablets. If an object matches any one of the tags in a purge request, then its cache will be refreshed. Note that cache tags are case-sensitive.

Cache tag constraints:

  • If there are multiple Edge-Cache-Tag headers in the origin response, only the first is considered.

  • Tags in headers are derived from the ABNF token format. (see RFC 7230). Tag characters are limited to this set: [A-Za-z0-9!#$%&'+-/.^_`~].

  • Tag names cannot exceed 128 bytes.

  • Use commas to delimit more than one value in the Edge-Cache-Tag header.

  • End users do not receive the Edge-Cache-Tag header.

Sample Code and Use Cases

For sample code related to this API, see the api-kickstart repository.

For sample use cases, see the examples folder in the api-kickstart repository. It is continually being updated with new examples for Akamai APIs.

Rate Limiting

This API is protected by rate controls that limit the number of API calls a single client can make per second. A single client can submit at a sustained rate of up to 20 API calls per second, calculated as an average over a 2 minute window. This means that a single client can make up to 2400 API calls within a 2 minute window. To purge more objects while remaining within this limit, you should combine many objects into a single API call. A single API call can specify many objects of the same type, as long as the request body is less than 50,000 bytes. When you exceed the rate limit, the API will respond with a 429 error such as the following:

HTTP/1.1 429 Too Many Requests
Content-Length: 464
Date: Wed, 18 Oct 2017 18:48:49 GMT
Connection: close
Content-Type: application/problem+json
X-Akamai-Staging: ESSL

{
    "type": "https://problems.purge.akamaiapis.net/-/pep-authn/request-error",
    "title": "Too Many Requests",
    "status": 429,
    "detail": "WAF deny rule IPBLOCK-SUMMARY8-67128",
    "instance": "https://akab-cje2qk2cvs7pct57-ib4ea4mdebhj24pa.purge.akamaiapis.net/ccu/v3/invalidate/url",
    "method": "POST",
    "serverIp": "2600:1407:21:382::2621",
    "clientIp": "2001:4878:8000:60:fab1:56ff:feb9:5b85",
    "requestId": "2fcb97a",
    "requestTime": "2017-10-18T18:48:49Z"
}

Please note that the response body does not provide any data about the rate limit usage, or when a client should try again after a 429 response.


Last modified: 11/7/2017