Content Control Utility API Resources

The Content Control Utility (CCU) API allows you to purge edge content. You can use the API to purge by URL, by Content Provider (CP) code, or by cache tag.

This API leverages the Fast Purge Utility. Here is how fast invalidate and delete purges execute both with and without Fast Purge:

  • With Fast Purge enabled on your account, estimated time to complete is approximately five seconds.

  • If Fast Purge is not enabled on your account, the Content Control Utility API v2 processes the purge in approximately 4–7 minutes.

For all requests, you can choose either the staging or production network. If you do not specify a network, the operation applies to production.

NOTE: Cache tag operations (Invalidate and Delete) are only available to select beta customers.

API Summary

Operation Method Endpoint
Invalidations   (download RAML)
Invalidate by URL POST /ccu/v3/invalidate/url/{network}
Invalidate by CP Code POST /ccu/v3/invalidate/cpcode/{network}
Invalidate by Cache Tag POST /ccu/v3/invalidate/tag/{network}
Deletions   (download RAML)
Delete by URL POST /ccu/v3/delete/url/{network}
Delete by CP Code POST /ccu/v3/delete/cpcode/{network}
Delete by Cache Tag POST /ccu/v3/delete/tag/{network}

Invalidate by URL

Invalidates content on the selected URL 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.

POST /ccu/v3/invalidate/url/{network}

Sample: /ccu/v3/invalidate/url/staging

Content-Type: application/json

Request Body:

{
    "objects": [
        "https://foo1.bar.com/some/path",
        "http://foo2.bar.com/some/other/path"
    ]
}
Parameter Type Sample Description
URL Parameters
network Enumeration staging The network on which you want to invalidate or delete content, either staging or the default production network.

Status 201 application/json

Response Body:

{
    "purgeId": "e535071c-26b2-11e7-94d7-276f2f54d938",
    "estimatedSeconds": 5,
    "httpStatus": 201,
    "detail": "Request accepted",
    "supportId": "17PY1492793544958045-219026624"
}

Invalidate by CP Code

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.

POST /ccu/v3/invalidate/cpcode/{network}

Sample: /ccu/v3/invalidate/cpcode/staging

Content-Type: application/json

Request Body:

{
    "objects": [
        12345,
        98765
    ]
}
Parameter Type Sample Description
URL Parameters
network Enumeration staging The network on which you want to invalidate or delete content, either staging or the default production network.

Status 201 application/json

Response Body:

{
    "purgeId": "e535071c-26b2-11e7-94d7-276f2f54d938",
    "estimatedSeconds": 5,
    "httpStatus": 201,
    "detail": "Request accepted",
    "supportId": "17PY1492793544958045-219026624"
}

Invalidate by Cache Tag

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. Invalidate by Cache Tag is available to select beta customers only.

POST /ccu/v3/invalidate/tag/{network}

Sample: /ccu/v3/invalidate/tag/staging

Content-Type: application/json

Request Body:

{
    "objects": [
        "black-friday",
        "electronics",
        "laptops",
        "tablets"
    ]
}
Parameter Type Sample Description
URL Parameters
network Enumeration staging The network on which you want to invalidate or delete content, either staging or the default production network.

Status 201 application/json

Response Body:

{
    "purgeId": "e535071c-26b2-11e7-94d7-276f2f54d938",
    "estimatedSeconds": 5,
    "httpStatus": 201,
    "detail": "Request accepted",
    "supportId": "17PY1492793544958045-219026624"
}

Delete by URL

Deletes content on the selected URL for the selected network. In most cases, you should invalidate rather than delete content.

POST /ccu/v3/delete/url/{network}

Sample: /ccu/v3/delete/url/staging

Content-Type: application/json

Request Body:

{
    "objects": [
        "https://foo1.bar.com/some/path",
        "http://foo2.bar.com/some/other/path"
    ]
}
Parameter Type Sample Description
URL Parameters
network Enumeration staging The network on which you want to invalidate or delete content, either staging or the default production network.

Status 201 application/json

Response Body:

{
    "purgeId": "e535071c-26b2-11e7-94d7-276f2f54d938",
    "estimatedSeconds": 5,
    "httpStatus": 201,
    "detail": "Request accepted",
    "supportId": "17PY1492793544958045-219026624"
}

Delete by CP Code

Deletes content on the selected CP code for the selected network. In most cases, you should invalidate rather than delete content.

POST /ccu/v3/delete/cpcode/{network}

Sample: /ccu/v3/delete/cpcode/staging

Content-Type: application/json

Request Body:

{
    "objects": [
        12345,
        98765
    ]
}
Parameter Type Sample Description
URL Parameters
network Enumeration staging The network on which you want to invalidate or delete content, either staging or the default production network.

Status 201 application/json

Response Body:

{
    "purgeId": "e535071c-26b2-11e7-94d7-276f2f54d938",
    "estimatedSeconds": 5,
    "httpStatus": 201,
    "detail": "Request accepted",
    "supportId": "17PY1492793544958045-219026624"
}

Delete by Cache Tag

Deletes content on the selected set of cache tags for the selected network. In most cases, you should invalidate rather than delete content. Delete by Cache Tag is available to select beta customers only.

POST /ccu/v3/delete/tag/{network}

Sample: /ccu/v3/delete/tag/staging

Content-Type: application/json

Request Body:

{
    "objects": [
        "black-friday",
        "electronics",
        "laptops",
        "tablets"
    ]
}
Parameter Type Sample Description
URL Parameters
network Enumeration staging The network on which you want to invalidate or delete content, either staging or the default production network.

Status 201 application/json

Response Body:

{
    "purgeId": "e535071c-26b2-11e7-94d7-276f2f54d938",
    "estimatedSeconds": 5,
    "httpStatus": 201,
    "detail": "Request accepted",
    "supportId": "17PY1492793544958045-219026624"
}

Last modified: 10/27/2017