List ECCU requests

get https://{hostname}/eccu-api/v1/requests

Returns a summary of submitted ECCU refresh requests under your account. Use this to view the status of all refresh requests.

Recipes

List ECCU requests

Open Recipe

Response

Response body

object

requests

array of objects

required

length ≥ 0

Provides information about an ECCU request.

requests*

object

extendedStatusMessage

string

length ≥ 1

Further detail about the status of a request. Typically there is more information provided for a failed refresh request.

notes

string

length ≥ 1

Contains tags that define a refresh request based on request parameters such as directory path and file extension. Use only ASCII characters. For more information on the format of an ECCU request file and metadata tag usage, see Create the ECCU request file.

propertyName

string

required

length ≥ 1

Identifies the digital property whose content you want to refresh.

propertyNameExactMatch

boolean

required

Specifies whether to exactly match the full string of the propertyName, or to perform an inexact right hand side (RHS) substring match. For example, with propertyNameExactMatch enabled, example.com doesn't match www.example.com.

propertyType

string

required

Specifies the type of digital property. Either ARL_TOKEN or HOST_HEADER. This tells the edge network whether the purge information is contained in the ARL, or in a configuration file. The ARL is similar to the URL, but the ARL is specifically defined for objects to be served by the edge network. There are two types of ARLs, v1 and v2. For details, see the Purge Cache documentation.

ARL_TOKEN HOST_HEADER

requestDate

date-time

The time the refresh request was submitted, in ISO 8601 format.

requestId

integer

≥ 0

A unique identifier for the refresh request. Use this to track issues with the request.

requestName

string

length ≥ 1

The name that you give to the refresh request.

requestor

string

length ≥ 1

The username of the person who submitted the request. For example, john.doe@example.com.

status

string

Specifies the condition of the refresh request. Possible values are PENDING, SUCCEEDED, FAILED, or IGNORED. If you form the metadata incorrectly, the refresh request fails.

FAILED IGNORED PENDING SUCCEEDED

statusMessage

string

length ≥ 1

Details about the status of the refresh request.

statusUpdateDate

date-time

The time the refresh request's status last changed, in ISO 8601 format.

statusUpdateEmails

array of strings

length ≥ 0

A list of email addresses to notify when the status of the refresh request changes.

statusUpdateEmails

version

string

length ≥ 1

Use this to mark differences in your refresh requests.

200List ECCU requests.