Create an ECCU request

post

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

Creates a new ECCU refresh request.

Query Params

accountSwitchKey

string

Runs the operation from another account. The Identity and Access Management API provides a list of available account switch keys.

Body Params

metadata

string

required

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 Enhanced CCU Request Format.

notes

string

length ≥ 1

In addition to the requestName, this provides information to help you track the refresh request.

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

enum

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.

Allowed:

requestName

string

length ≥ 1

The name that you give to the refresh request.

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.

Headers

string

enum

Defaults to application/json

Generated from available response content types

Allowed:

Responses

201The operation was successful.

400Problem with the request.