Update or Delete Rule
Update — omit _METHOD or do not send it; the full rule options object is sent as the body and the rule is updated in place.
Delete — include "_METHOD": "DELETE" as the only body field. The rule identified by ruleId is permanently removed.
curl -X POST "https://api.5centscdn.com/v2/zones/vod/push/12345/rules/rule/201" \
-H "Content-Type: application/json" \
-H "X-API-Key: YOUR_API_KEY" \
-d '{
"name": "Cache Stream",
"rule": "/live/*",
"options": {
"edge_cache_settings": {
"enabled": null,
"control": "default",
"default": "345600s",
"value": "345600s",
"revalidate": null,
"custom": {
"default": "",
"value": ""
},
"custom_values": {
"codes": [],
"value": []
}
},
"cors": {
"enabled": null,
"control": "*",
"always": false,
"value": "*",
"custom": ""
}
}
}'
import requests
import json
url = "https://api.5centscdn.com/v2/zones/vod/push/12345/rules/rule/201"
headers = {
"Content-Type": "application/json",
"X-API-Key": "YOUR_API_KEY"
}
data = {
"name": "Cache Stream",
"rule": "/live/*",
"options": {
"edge_cache_settings": {
"enabled": null,
"control": "default",
"default": "345600s",
"value": "345600s",
"revalidate": null,
"custom": {
"default": "",
"value": ""
},
"custom_values": {
"codes": [],
"value": []
}
},
"cors": {
"enabled": null,
"control": "*",
"always": false,
"value": "*",
"custom": ""
}
}
}
response = requests.post(url, headers=headers, json=data)
print(response.json())
const response = await fetch("https://api.5centscdn.com/v2/zones/vod/push/12345/rules/rule/201", {
method: "POST",
headers: {
"Content-Type": "application/json",
"X-API-Key": "YOUR_API_KEY"
},
body: JSON.stringify({
"name": "Cache Stream",
"rule": "/live/*",
"options": {
"edge_cache_settings": {
"enabled": null,
"control": "default",
"default": "345600s",
"value": "345600s",
"revalidate": null,
"custom": {
"default": "",
"value": ""
},
"custom_values": {
"codes": [],
"value": []
}
},
"cors": {
"enabled": null,
"control": "*",
"always": false,
"value": "*",
"custom": ""
}
}
})
});
const data = await response.json();
console.log(data);
package main
import (
"fmt"
"net/http"
"bytes"
"encoding/json"
)
func main() {
data := []byte(`{
"name": "Cache Stream",
"rule": "/live/*",
"options": {
"edge_cache_settings": {
"enabled": null,
"control": "default",
"default": "345600s",
"value": "345600s",
"revalidate": null,
"custom": {
"default": "",
"value": ""
},
"custom_values": {
"codes": [],
"value": []
}
},
"cors": {
"enabled": null,
"control": "*",
"always": false,
"value": "*",
"custom": ""
}
}
}`)
req, err := http.NewRequest("POST", "https://api.5centscdn.com/v2/zones/vod/push/12345/rules/rule/201", bytes.NewBuffer(data))
if err != nil {
panic(err)
}
req.Header.Set("Content-Type", "application/json")
req.Header.Set("X-API-Key", "YOUR_API_KEY")
client := &http.Client{}
resp, err := client.Do(req)
if err != nil {
panic(err)
}
defer resp.Body.Close()
fmt.Println("Response Status:", resp.Status)
}
require 'net/http'
require 'json'
uri = URI('https://api.5centscdn.com/v2/zones/vod/push/12345/rules/rule/201')
http = Net::HTTP.new(uri.host, uri.port)
http.use_ssl = true
request = Net::HTTP::Post.new(uri)
request['Content-Type'] = 'application/json'
request['X-API-Key'] = 'YOUR_API_KEY'
request.body = '{
"name": "Cache Stream",
"rule": "/live/*",
"options": {
"edge_cache_settings": {
"enabled": null,
"control": "default",
"default": "345600s",
"value": "345600s",
"revalidate": null,
"custom": {
"default": "",
"value": ""
},
"custom_values": {
"codes": [],
"value": []
}
},
"cors": {
"enabled": null,
"control": "*",
"always": false,
"value": "*",
"custom": ""
}
}
}'
response = http.request(request)
puts response.body
{
"result": "success",
"message": "Zone EdgeRule Updated. Please wait till the rules validation & deployment completes."
}
{
"result": "success",
"message": "Zone EdgeRule Deleted. Please wait till the deployment completes."
}
{
"error": "Bad Request",
"message": "The request contains invalid parameters or malformed data",
"code": 400,
"details": [
{
"field": "email",
"message": "Invalid email format"
}
]
}
{
"error": "Unauthorized",
"message": "Authentication required. Please provide a valid API token",
"code": 401
}
POST
/zones/vod/push/{zoneId}/rules/rule/{ruleId}POST
Base URLstring
Target server for requests. Edit to use your own host.
API Key (header: X-API-Key)
X-API-Keystring
RequiredAPI key (sent in header)
path
zoneIdinteger
RequiredNumeric ID of the zone
path
ruleIdinteger
RequiredNumeric ID of the edge rule to update or delete
Content-Typestring
RequiredThe media type of the request body
Options: application/json
namestring
RequiredPre-populated rule name. Send back as received from GET rules.
rulestring
RequiredPre-populated rule pattern. Send back as received from GET rules.
optionsobject
RequiredFull options object for the rule update.
Request Preview
Response
Response will appear here after sending the request
Authentication
header
X-API-Keystring
RequiredAPI Key for authentication. Provide your API key in the header.
Path Parameters
Body
application/json
namestring
RequiredPre-populated rule name. Send back as received from GET rules.
Example:
Cache Streamoptionsobject
RequiredFull options object for the rule update.
edge_cache_settingsobject
CDN edge cache TTL configuration.
enabledboolean
Example:
nullcontrolstring
Allowed values:
defaultvalueno-cachedefaultstring
Example:
345600svaluestring
Example:
345600srevalidatestring
Example:
nullcustomobject
defaultstring
Example:
valuestring
Example:
custom_valuesobject
codesarray
Example:
[]valuearray
Example:
[]midgress_cache_settingsobject
CDN midgress cache TTL configuration.
enabledboolean
Example:
nullcontrolstring
Allowed values:
defaultvaluedefaultstring
Example:
345600svaluestring
Example:
345600srevalidatestring
Example:
nullcustomobject
defaultstring
Example:
valuestring
Example:
custom_valuesobject
codesarray
Example:
[]valuearray
Example:
[]browser_cache_settingsobject
Browser-side Cache-Control TTL configuration.
enabledboolean
Example:
nullcontrolstring
Allowed values:
defaultno-cachecustomvaluestring
Example:
345600scustomobject
valuestring
Example:
country_aclobject
Allow or block requests by country.
enabledboolean
Example:
nullpolicy_typestring
Allowed values:
allowdenyexcepted_valuesarray
Example:
[]ip_whitelistsarray
Example:
[]ip_address_aclobject
Allow or block requests by IP address.
enabledboolean
Example:
nullpolicy_typestring
Allowed values:
allowdenyexcepted_valuesarray
Example:
[]ip_whitelistsarray
Example:
[]user_agent_aclobject
Allow or block requests by User-Agent header.
enabledboolean
Example:
nullpolicy_typestring
Allowed values:
allowdenyexcepted_valuesarray
Example:
[]ip_whitelistsarray
Example:
[]casesensitiveboolean
Example:
falsereferrer_aclobject
Allow or block requests by Referer header.
enabledboolean
Example:
nullpolicy_typestring
Allowed values:
allowdenynorefererboolean
Example:
falseexcepted_valuesarray
Example:
[]ip_whitelistsarray
Example:
[]secure_keyobject
Signed URL token authentication.
enabledboolean
Example:
nullsessioninteger
Example:
0keystring
Example:
ip_whitelistsarray
Example:
[]typeboolean
Example:
falselimit_bandwidthobject
Per-connection download speed throttling.
enabledboolean
Example:
nulllimit_typestring
Allowed values:
staticdynamicspeedinteger
Example:
12000bufferinteger
Example:
1024limit_requestobject
Per-IP request rate limiting.
enabledboolean
Example:
nullrateinteger
Example:
9burstinteger
Example:
98delayinteger
Example:
96ip_whitelistsarray
Example:
[]rewriteobject
Nginx-style URL rewrite rule.
host_redirectobject
Redirect requests to a different hostname.
redirect_http_to_httpsobject
Permanently redirect HTTP requests to HTTPS (301).
enabledboolean
Example:
nullhstsobject
HTTP Strict Transport Security configuration.
enabledboolean
Example:
nullreferrerPolicystring
Allowed values:
no-referrerno-referrer-when-downgradeoriginorigin-when-cross-originsame-originstrict-originstrict-origin-when-cross-originunsafe-urlincludeSubDomainsboolean
Example:
truepreloadboolean
Example:
trueforce_returnobject
Return a fixed HTTP status code for matched requests.
staleobject
Serve stale cached content if origin is unreachable.
enabledboolean
Example:
nullvaluestring
Example:
staticHeadersobject
Add or override response headers.
corsobject
CORS header support.
enabledboolean
Example:
nullcontrolstring
Example:
*alwaysboolean
Example:
falsevaluestring
Example:
*customstring
Example:
Responses
resultstring
RequiredStatus of the API response.
Allowed values:
successmessagestring
Requiredresultstring
RequiredAllowed values:
errormessagestring
Requiredresultstring
Allowed values:
errormessagestring
Was this page helpful?