Cache rule configuration

You can use the API to configure cache rules for directories, file names, and full paths.

• Directory-based configuration: Directories must begin with a forward slash (/) (for example, /pic, /doc, or /htdoc/data). The back end matches all files within the designated directory, including subdirectories.
• File extension-based configuration: Common file extensions, such as .jpg, .png, .gif, .txt, .m4v, or .mp3. The back end matches the specified file suffixes within all folders.
• Full path-based configuration: Used to specify a single file, and must start with a forward slash (/) (for example, /sites/doc/example.doc) [!NOTE]
If the path that you enter is “/”, it will match the home page.

[!NOTE] 
The character strings that you enter when you configure rules must not include any of the following special characters: {, }, (, ), [, ], ., ?, *, , ^, or $.

[!NOTE]
A time value of 0 indicates that caching is disabled, and the no-cache rules are prioritized.  

Request

URI parameter

Request header

Request body

{
  "Rules": [
    {
      "Type": "Dir",
      "Items": [
        "/test1/",
        "/test2/"
      ],
      "TTL": 86400
    },
    {
      "Type": "Suffix",
      "Items": [
        "7z",
        "apk",
        "wdf",
        "cab"
      ],
      "TTL": 2592000
    },
    {
      "Type": "FullUri",
      "Items": [
        "/test1/test.xml",
        "/test2/test.txt"
      ],
      "TTL": 86400
    },
  ],
  "IgnoreCacheControl": false,
  "IgnoreCookie": false,
  "IgnoreQueryString": false
}

Response

A response comprises a status code, response headers, and a response body.

Status code

Response header

Response body

JSON example for request succeeded:

{
  "Succeeded": true,
  "IsAsync": true,
  "AsyncInfo": {
    "TaskTrackId": "b520c544-ec34-4ac4-86f5-5394363919c3",
    "TaskStatus": "Processing"
  }
}

JSON example for request failed:

{
  "Succeeded": false,
  "ErrorInfo": {
    "Type": "MissingAuthorizationHeader",
    "Message": "Missing authorization header."
  }
}