Content Control Utility v2

API Summary

Operation Method Endpoint
Request Queues
Get Current Queue Size GET /ccu/v2/queues/{queueName}
Add a Request POST /ccu/v2/queues/{queueName}
Purge Status
Get Purge Status GET /ccu/v2/purges/{purgeId}

Get Current Queue Size

Retrieves the length of the queue length.

GET /ccu/v2/queues/{queueName}

Example: /ccu/v2/queues/default

Parameter Type Sample Description
Required
queueName String default Name of the queue. Currently supported options are default and emergency.

Status 200 application/json

Response:

{
   "supportId": "17QY1405953107052757-292938848",
   "httpStatus": 200,
   "detail": "The queue may take a minute to reflect new or removed requests.",
   "queueLength": 4
}

Add a Request

Requests that the given objects (URLs, ARLs, or CPCodes) are purged.

POST /ccu/v2/queues/{queueName}

Example: /ccu/v2/queues/default

Content-Type: application/json

Request:

{
    "objects": [
        "/f/4/6848/4h/www.foofoofoo.com/index.php",
        "/f/4/6848/4h/www.oofoofoof.com/index2.php",
        "http://www.example.com/graphics/picture.gif",
        "http://www.example.com/documents/brochure.pdf"
    ],
    "action": "remove",
    "type": "arl",
    "domain": "production"
}

Parameter Type Sample Description
Required
queueName String default Name of the queue. Currently supported options are default and emergency.

Status 201 application/json

Response:

{
    "estimatedSeconds": 420,
    "progressUri": "/ccu/v2/purges/57799d8b-10e4-11e4-9088-62ece60caaf0",
    "purgeId": "57799d8b-10e4-11e4-9088-62ece60caaf0",
    "supportId": "17PY1405953363409286-284546144",
    "httpStatus": 201,
    "detail": "Request accepted.",
    "pingAfterSeconds": 420
}

On success, returns a 201 status and a response including the progressUri that can be used to retrieve the status of the request (see below).

NOTE: always check for the 201 status to confirm the request was successfully received.

The following table lists the properties of the JSON request:

Member Type Description
Required
objects Array List of URLs, ARLs, or CPCodes
Optional
action String The action to take, either remove (default) or invalidate
domain String The domain, either production (default) or staging
type String The type of the objects, either arl (default) or cpcode

For the action field, remove deletes the content from Edge server caches. The next time an Edge server receives a request for the content, it will retrieve the current version from the origin server. If it cannot retrieve a current version, it will follow instructions in your server configuration. invalidate marks the cached content as invalid. The next time a server receives a request for the content, it sends an HTTP conditional GET (If-Modified-Since) request to the origin. If the content has changed, the origin server returns a full fresh copy. Otherwise, the origin normally responds that the content has not changed, and the Edge server can serve the already-cached content.

Get Purge Status

Get the status of a purge request.

GET /ccu/v2/purges/{purgeId}

Example: /ccu/v2/purges/57799d8b–10e4–11e4–9088–62ece60caaf0

Parameter Type Sample Description
Required
purgeId String 57799d8b-10e4-11e4-9088-62ece60caaf0 The purgeId returned from the POST to the queue.

Status 200 application/json

Response:

{
    "originalEstimatedSeconds": 420,
    "originalQueueLength": 0,
    "supportId": "17SY1405954814899441-292938848",
    "httpStatus": 200,
    "purgeId": "57799d8b-10e4-11e4-9088-62ece60caaf0",
    "completionTime": "2014-07-21T14:42:18Z",
    "submittedBy": "client_name",
    "purgeStatus": "In-Progress",
    "submissionTime": "2014-07-21T14:39:30Z"
}

The following table describes the fields of the response JSON:

Member Type Description
httpStatus Number The HTTP status code
purgeStatus String The status of the request. Either In-Progress or Done.
completionTime String The approximate time that the request was completed, or null if not yet complete
supportId String Reference for this status request provided to CCare if needed
purgeId String The unique ID for the purge request
submissionTime String The approximate time the request was submitted
submittedBy String Identifies the submitter of the purge request
originalEstimatedSeconds Number Time in seconds originally estimated
originalQueueLength Number The approximate queue length at the time of the submission

Last modified: 12/12/2016