The Content Control Utility API

The Content Control Utility (CCU) API allows you to purge edge content by request. In this version, you can use the API to purge by URL only. Purging by Content Provider (CP) code will be supported in a later version. This API leverages the new Fast Purge utility, and is only accessible via {OPEN} authentication.

The Luna Control Center provides a graphical interface to Fast Purge for content administrators. This API provides a programmatic interface for developers.

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 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 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:

  • To use Fast Purge with this API, you must enable it in the Fast Purge Transition Application, which is available on the Publish tab in the Luna Control Center.

  • Review the {OPEN} API Introduction section on available tools.

  • Review Open API Provisioning to create your OPEN API access credentials and authorizations. When creating, adding, and naming clients for OPEN 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 the {OPEN} developer community or Akamai Customer Care (1–877–425–2832), 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: Fast Purge is a new purge utility that completes purge requests within approximately five seconds. Currently, Fast Purge supports requests to invalidate or delete URLs on Akamai Staging and Production networks. As Fast Purge moves to Limited and General Availability, it will support all purge methods currently covered by previous versions of CCU.

  • 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..

Sample Code and Use Cases

For sample code related to this API, see Akamai’s api-kickstart repository.

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

Rate Limiting

This API supports the following rate limits per customer:

  • 6,000 URLs per minute (sustained)
  • 5,000 URLs per second (burst)

Purge requests submitted at a higher rate may result in a 507 error code. If you receive this error, wait 5 seconds and try again.

In addition, there is a strictly enforced 50,000 byte limit on the size of each request.