Content Control Utility API Data

This section describes the data model for the Content Control Utility (CCU) API.

Schemas

UrlRequest

Specifies a list of URLs to invalidate or delete.

Sample POST request:

{
    "hostname": "origin.qux.com",
    "objects": [
        "/some/path/object1",
        "/some/other/path/object2"
    ]
}

UrlRequest Members

Member Type Required Description
hostname String Identifies the domain from which the content is purged.
objects Array Lists URLs to purge, or server paths if a common hostname is specified. Each purges content for both http and https schemes.

CpCodeRequest

Specifies a list of CP codes to invalidate or delete.

Sample POST request:

{
    "objects": [
        12345,
        98765
    ]
}

CpCodeRequest Members

Member Type Required Description
objects Array For CP code-based operations, an array of the CP codes you want to purge.

TagRequest

Specifies a list of cache tags to invalidate or delete.

Sample POST request:

{
    "objects": [
        "black-friday",
        "electronics",
        "laptops",
        "tablets"
    ]
}

TagRequest Members

Member Type Required Description
objects Array An array of cache tag strings you want to purge.

Response

V3 Purge response schema

Sample POST response:

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

Response Members

Member Type Required Description
describedBy String The URL for the API’s machine readable documentation, for example, https://api.ccu.akamai.com/ccu/v2/errors/internal-error. It describes the error code in more detail.
detail String Detailed information about the HTTP status code returned with the response.
estimatedSeconds Integer The estimated number of seconds before the purge is to complete.
httpStatus Integer The HTTP code that indicates the status of the request to invalidate or purge content. Successful requests yield a 201 code.
purgeId String Unique identifier for the purge request.
supportId String Identifier to provide Akamai Technical Support if issues arise.
title String Describes the response type, for example, Rate Limit exceeded.

Last modified: 10/10/2017