Akamai APIs API Documentation

Fast Purge API v3

Number of APIs: 7

Use the Fast Purge API to purge edge content, including URLs, ARLs (Akamai resource locators), or any content grouped under a content provider (CP) code or cache tag.

Authentication

Create an authentication credential that contains the client token and client secret required to authenticate Akamai API requests.

Note: Only Akamai customers can create credentials. If you aren't an Akamai customer and wish to become one, you can sign up for our services.

Navigate to the Identity and Access Management section of Akamai Control Center and click Create API Client.

Note: If you don't have access to the Identity and Access Management tool, contact your local Akamai Control Center admin or your Akamai account team for assistance.

Click Quick and then Download in the Credentials section.

Note: If you need to refine access levels or permissions, see Create a client with custom permissions.

Open the downloaded file with a text editor and add [default] as a header above all text.

  [default]
  client_secret = C113nt53KR3TN6N90yVuAgICxIRwsObLi0E67/N8eRN=
  host = akab-h05tnam3wl42son7nktnlnnx-kbob3i3v.luna.akamaiapis.net
  access_token = akab-acc35t0k3nodujqunph3w7hzp7-gtm6ij
  client_token = akab-c113ntt0k3n4qtari252bfxxbsl-yvsdj

Fork the [Akamai Authentication] environment, populate the variables, and [set it for your workspace]

Dependencies

To purge by a directory or extension, use the Enhanced Content Control Utility API.
To purge streaming or media content, use the Media Services API.

Integration methods

You can use this API collection in these integration methods: - API

1. Cache tag - Delete by cache tag

POST https://{{host}}/ccu/v3/delete/tag/:network

Deletes content on the selected set of cache tags for the selected network. In most cases, you should invalidate rather than delete content. Invalidation keeps each object in cache until the version on your origin server is newer. Deletion retrieves the object regardless, which can dramatically increase the load on your origin server and would prevent Akamai from serving the old content if your origin is unreachable.

2. Cache tag - Invalidate by cache tag

POST https://{{host}}/ccu/v3/invalidate/tag/:network

Invalidates content on the selected set of cache tags for the selected network. You should consider invalidating content by default. This keeps each object in cache until the version on your origin server is newer. Deletion retrieves the object regardless, which can dramatically increase the load on your origin server and would prevent Akamai from serving the old content if your origin is unreachable.

3. URL/ARL - Delete by URL or ARL

POST https://{{host}}/ccu/v3/delete/url/:network

Deletes content on the selected URL or ARL for the selected network. URLs and ARLs can be submitted in the same request. In most cases, you should invalidate rather than delete content. Invalidation keeps each object in cache until the version on your origin server is newer. Deletion retrieves the object regardless, which can dramatically increase the load on your origin server and would prevent Akamai from serving the old content if your origin is unreachable.

4. URL/ARL - Invalidate by URL or ARL

POST https://{{host}}/ccu/v3/invalidate/url/:network

Invalidates content on the selected URL or ARL for the selected network. You should consider invalidating content by default. This keeps each object in cache until the version on your origin server is newer. Deletion retrieves the object regardless, which can dramatically increase the load on your origin server and would prevent Akamai from serving the old content if your origin is unreachable. URLs and ARLs can be submitted in the same request.

5. CP code - Delete by CP code

POST https://{{host}}/ccu/v3/delete/cpcode/:network

Deletes content on the selected CP code for the selected network. In most cases, you should invalidate rather than delete content. Invalidation keeps each object in cache until the version on your origin server is newer. Deletion retrieves the object regardless, which can dramatically increase the load on your origin server and would prevent Akamai from serving the old content if your origin is unreachable.

6. CP code - Invalidate by CP code

POST https://{{host}}/ccu/v3/invalidate/cpcode/:network

Invalidates content on the selected CP code for the selected network. You should consider invalidating content by default. This keeps each object in cache until the version on your origin server is newer. Deletion retrieves the object regardless, which can dramatically increase the load on your origin server and would prevent Akamai from serving the old content if your origin is unreachable.

7. Rate limits - Check rate and object limit statuses

POST https://{{host}}/ccu/v3/rate-limit-status/:purge-type

The Fast Purge API uses a token bucket model for rate limiting to protect itself from inadvertent or malicious overuse. For each Akamai account, there's a rate limit shared by all object types (CP codes, cache tags, and URL/ARLs), and three separate resource limits for each object type. Each purge request uses one rate limit token from the requests bucket. Each purge object in a request takes up a token from the resource bucket. This operation fetches information on the remaining number of requests and objects for a specific account. You can use these details to monitor the request consumption or throttle requests to prevent exceeding the limits, which results in the 429 error.