PurgeFileWithTag
Update time: 2026-07-28 19:04:31
Applicable Products
Content MGMT
API Description
Push the file with the tag in the domain name with the tag switch enabled under the customer
- API URL: https://api.atomile.com/api/content/tag/purge
- Method: POST
Call frequency
Single user trigger frequency: 30/5min
Request parameter(s)
Body Params
| Name | Description |
|---|---|
*tagString | Tag value:
1. Separate multiple tag values with commas, allowing a maximum of 30 values.
2. Each tag value can have a maximum length of 128 characters.
3. Special characters are not allowed. These include Chinese characters, spaces, and''(),:;<=>?@[]{}<>. |
actionString | 1. If left blank, the default value is 0.
2. 0 represents deletion; 1 represents expiration. |
Response parameter(s)
Body Params
| Name | Description |
|---|---|
CodeString | code |
MessageString | message |
itemIdString | itemId |
Error code
| Error code(code) | Description(message) | HTTP status | Semantic |
|---|---|---|---|
| Success | Task submitted successfully | 200 | Task submitted successfully |
| ParseParameterError | JSON parsing error | 400 | JSON parsing error |
| UserNameInvalid | The userName is empty or not enabled or non-primary account | 400 | The userName is empty or not enabled or non-primary account |
| ActionInvalid | Action type must be 0 or 1 | 400 | Action type must be 0 or 1 |
| TagIsEmpty | Tag cannot be empty | 400 | Tag cannot be empty |
| SingleTagLengthLessThan128 | A single tag cannot exceed 128 characters | 400 | A single tag cannot exceed 128 characters |
| TagCountLessThan30 | The number of tags cannot exceed 30 | 400 | The number of tags cannot exceed 30 |
| TagValueIsIllegal | Tag value cannot contain special characters or Chinese | 400 | Tag value cannot contain special characters or Chinese |
| ExceedDailyLimit | 1.User [userName] exceeds daily tag purge limit of 2000\n2.If the header includes a timezone, indicate the corresponding timezone interval, e.g., "the user[userName] between 2018-10-17 01:00:00GMT+09:00 and 2018-10-18 00:59:59GMT+09:00 purge tags exceeds the limit[2000]" | 400 | 1.User [userName] exceeds daily tag purge limit of 2000\n2.If the header includes a timezone, indicate the corresponding timezone interval, e.g., "the user[userName] between 2018-10-17 01:00:00GMT+09:00 and 2018-10-18 00:59:59GMT+09:00 purge tags exceeds the limit[2000]" |
| NotEnableTagPurge | User [userName] has not enabled any channel tag purge | 400 | User [userName] has not enabled any channel tag purge |
| NotFindAppgGroup | User [userName] did not find any appservice group for tag purge | 400 | User [userName] did not find any appservice group for tag purge |
| SystemException | Internal system exception | 500 | Internal system exception |
Example
JSON
- Request example Copy success
#!/bin/bash username="username_exmaple" apiKey="apiKey_exmaple" date=`env LANG="en_US.UTF-8" date -u "+%a, %d %b %Y %H:%M:%S GMT"` password=`echo -en "$date" | openssl dgst -sha1 -hmac $apiKey -binary | openssl enc -base64` curl -i --url "https://api.atomile.com/api/content/tag/purge" \ -X "POST" \ -u "$username:$password" \ -H "Date:$date" \ -H "Content-Type: application/json" \ -d'{ "tag": "abc,edf,wcs", "action": "0" }'- Response example Copy success
{ "Code":Success, "Message":"handle success", "itemId":"64ec364dd81d4052a3534c1e86167950" }