Create Rule
Creates a new edge rule for the zone. The body must include "_METHOD": "PUT" alongside the standard rule payload. On success the server returns result: "success" with a human-readable message.
curl -X POST "https://api.5centscdn.com/v2/zones/vod/pull/12345/rules/rule" \
-H "Content-Type: application/json" \
-H "X-API-Key: YOUR_API_KEY" \
-d '{
"_METHOD": "PUT",
"name": "Cache Segments",
"rule": "/stream/*",
"options": {
"edge_cache_settings": {
"enabled": null,
"control": "default",
"default": "345600s",
"value": "345600s",
"revalidate": null,
"custom": {
"default": "",
"value": ""
},
"custom_values": {
"codes": [],
"value": []
}
},
"midgress_cache_settings": {
"enabled": null,
"control": "default",
"default": "345600s",
"value": "345600s",
"revalidate": null,
"custom": {
"default": "",
"value": ""
},
"custom_values": {
"codes": [],
"value": []
}
},
"browser_cache_settings": {
"enabled": null,
"control": "default",
"value": "345600s",
"custom": {
"value": ""
}
},
"ignore_cookie": {
"enabled": null
},
"ignoreQueryString": {
"enabled": null,
"control": null,
"value": null
},
"query_params_blacklist": {
"enabled": null,
"value": null
},
"query_params_whitelist": {
"enabled": null,
"value": null
},
"country_acl": {
"enabled": null,
"policy_type": "allow",
"excepted_values": [],
"ip_whitelists": []
},
"ip_address_acl": {
"enabled": null,
"policy_type": "allow",
"excepted_values": [],
"ip_whitelists": []
},
"user_agent_acl": {
"enabled": null,
"policy_type": "allow",
"excepted_values": [],
"ip_whitelists": [],
"casesensitive": false
},
"referrer_acl": {
"enabled": null,
"policy_type": "allow",
"noreferer": false,
"excepted_values": [],
"ip_whitelists": []
},
"secure_key": {
"enabled": null,
"policy_type": 0,
"session": 0,
"key": "",
"ip_whitelists": [],
"type": false
},
"limit_bandwidth": {
"enabled": null,
"limit_type": "static",
"speed": 12000,
"buffer": 1024
},
"limit_request": {
"enabled": null,
"rate": 9,
"burst": 98,
"delay": 96,
"ip_whitelists": []
},
"rewrite": {
"enabled": null,
"body": "",
"flag": "break"
},
"host_redirect": {
"enabled": null,
"to": "",
"value": []
},
"redirect_http_to_https": {
"enabled": null
},
"follow_origin_redirect": {
"enabled": null,
"codes": []
},
"hsts": {
"enabled": null,
"referrerPolicy": "no-referrer",
"includeSubDomains": true,
"preload": true
},
"xff": {
"enabled": null
},
"sni": {
"enabled": null,
"sni_type": "dynamic",
"custom_hostname": ""
},
"force_return": {
"enabled": null,
"code": 200,
"body": ""
},
"stale": {
"enabled": null,
"value": ""
},
"staticHeaders": {
"enabled": null,
"keys": [],
"values": []
},
"staticRequestHeaders": {
"enabled": null,
"keys": [],
"values": []
},
"response_headers_hiding_policy": {
"enabled": null,
"mode": "hide",
"expected": {
"hide": [],
"show": []
}
},
"hostHeader": {
"enabled": null,
"control": "forward",
"custom": ""
},
"forward_host_header": {
"enabled": null
},
"cors": {
"enabled": null,
"control": "*",
"always": false,
"value": "*",
"custom": ""
}
}
}'
import requests
import json
url = "https://api.5centscdn.com/v2/zones/vod/pull/12345/rules/rule"
headers = {
"Content-Type": "application/json",
"X-API-Key": "YOUR_API_KEY"
}
data = {
"_METHOD": "PUT",
"name": "Cache Segments",
"rule": "/stream/*",
"options": {
"edge_cache_settings": {
"enabled": null,
"control": "default",
"default": "345600s",
"value": "345600s",
"revalidate": null,
"custom": {
"default": "",
"value": ""
},
"custom_values": {
"codes": [],
"value": []
}
},
"midgress_cache_settings": {
"enabled": null,
"control": "default",
"default": "345600s",
"value": "345600s",
"revalidate": null,
"custom": {
"default": "",
"value": ""
},
"custom_values": {
"codes": [],
"value": []
}
},
"browser_cache_settings": {
"enabled": null,
"control": "default",
"value": "345600s",
"custom": {
"value": ""
}
},
"ignore_cookie": {
"enabled": null
},
"ignoreQueryString": {
"enabled": null,
"control": null,
"value": null
},
"query_params_blacklist": {
"enabled": null,
"value": null
},
"query_params_whitelist": {
"enabled": null,
"value": null
},
"country_acl": {
"enabled": null,
"policy_type": "allow",
"excepted_values": [],
"ip_whitelists": []
},
"ip_address_acl": {
"enabled": null,
"policy_type": "allow",
"excepted_values": [],
"ip_whitelists": []
},
"user_agent_acl": {
"enabled": null,
"policy_type": "allow",
"excepted_values": [],
"ip_whitelists": [],
"casesensitive": false
},
"referrer_acl": {
"enabled": null,
"policy_type": "allow",
"noreferer": false,
"excepted_values": [],
"ip_whitelists": []
},
"secure_key": {
"enabled": null,
"policy_type": 0,
"session": 0,
"key": "",
"ip_whitelists": [],
"type": false
},
"limit_bandwidth": {
"enabled": null,
"limit_type": "static",
"speed": 12000,
"buffer": 1024
},
"limit_request": {
"enabled": null,
"rate": 9,
"burst": 98,
"delay": 96,
"ip_whitelists": []
},
"rewrite": {
"enabled": null,
"body": "",
"flag": "break"
},
"host_redirect": {
"enabled": null,
"to": "",
"value": []
},
"redirect_http_to_https": {
"enabled": null
},
"follow_origin_redirect": {
"enabled": null,
"codes": []
},
"hsts": {
"enabled": null,
"referrerPolicy": "no-referrer",
"includeSubDomains": true,
"preload": true
},
"xff": {
"enabled": null
},
"sni": {
"enabled": null,
"sni_type": "dynamic",
"custom_hostname": ""
},
"force_return": {
"enabled": null,
"code": 200,
"body": ""
},
"stale": {
"enabled": null,
"value": ""
},
"staticHeaders": {
"enabled": null,
"keys": [],
"values": []
},
"staticRequestHeaders": {
"enabled": null,
"keys": [],
"values": []
},
"response_headers_hiding_policy": {
"enabled": null,
"mode": "hide",
"expected": {
"hide": [],
"show": []
}
},
"hostHeader": {
"enabled": null,
"control": "forward",
"custom": ""
},
"forward_host_header": {
"enabled": null
},
"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/pull/12345/rules/rule", {
method: "POST",
headers: {
"Content-Type": "application/json",
"X-API-Key": "YOUR_API_KEY"
},
body: JSON.stringify({
"_METHOD": "PUT",
"name": "Cache Segments",
"rule": "/stream/*",
"options": {
"edge_cache_settings": {
"enabled": null,
"control": "default",
"default": "345600s",
"value": "345600s",
"revalidate": null,
"custom": {
"default": "",
"value": ""
},
"custom_values": {
"codes": [],
"value": []
}
},
"midgress_cache_settings": {
"enabled": null,
"control": "default",
"default": "345600s",
"value": "345600s",
"revalidate": null,
"custom": {
"default": "",
"value": ""
},
"custom_values": {
"codes": [],
"value": []
}
},
"browser_cache_settings": {
"enabled": null,
"control": "default",
"value": "345600s",
"custom": {
"value": ""
}
},
"ignore_cookie": {
"enabled": null
},
"ignoreQueryString": {
"enabled": null,
"control": null,
"value": null
},
"query_params_blacklist": {
"enabled": null,
"value": null
},
"query_params_whitelist": {
"enabled": null,
"value": null
},
"country_acl": {
"enabled": null,
"policy_type": "allow",
"excepted_values": [],
"ip_whitelists": []
},
"ip_address_acl": {
"enabled": null,
"policy_type": "allow",
"excepted_values": [],
"ip_whitelists": []
},
"user_agent_acl": {
"enabled": null,
"policy_type": "allow",
"excepted_values": [],
"ip_whitelists": [],
"casesensitive": false
},
"referrer_acl": {
"enabled": null,
"policy_type": "allow",
"noreferer": false,
"excepted_values": [],
"ip_whitelists": []
},
"secure_key": {
"enabled": null,
"policy_type": 0,
"session": 0,
"key": "",
"ip_whitelists": [],
"type": false
},
"limit_bandwidth": {
"enabled": null,
"limit_type": "static",
"speed": 12000,
"buffer": 1024
},
"limit_request": {
"enabled": null,
"rate": 9,
"burst": 98,
"delay": 96,
"ip_whitelists": []
},
"rewrite": {
"enabled": null,
"body": "",
"flag": "break"
},
"host_redirect": {
"enabled": null,
"to": "",
"value": []
},
"redirect_http_to_https": {
"enabled": null
},
"follow_origin_redirect": {
"enabled": null,
"codes": []
},
"hsts": {
"enabled": null,
"referrerPolicy": "no-referrer",
"includeSubDomains": true,
"preload": true
},
"xff": {
"enabled": null
},
"sni": {
"enabled": null,
"sni_type": "dynamic",
"custom_hostname": ""
},
"force_return": {
"enabled": null,
"code": 200,
"body": ""
},
"stale": {
"enabled": null,
"value": ""
},
"staticHeaders": {
"enabled": null,
"keys": [],
"values": []
},
"staticRequestHeaders": {
"enabled": null,
"keys": [],
"values": []
},
"response_headers_hiding_policy": {
"enabled": null,
"mode": "hide",
"expected": {
"hide": [],
"show": []
}
},
"hostHeader": {
"enabled": null,
"control": "forward",
"custom": ""
},
"forward_host_header": {
"enabled": null
},
"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(`{
"_METHOD": "PUT",
"name": "Cache Segments",
"rule": "/stream/*",
"options": {
"edge_cache_settings": {
"enabled": null,
"control": "default",
"default": "345600s",
"value": "345600s",
"revalidate": null,
"custom": {
"default": "",
"value": ""
},
"custom_values": {
"codes": [],
"value": []
}
},
"midgress_cache_settings": {
"enabled": null,
"control": "default",
"default": "345600s",
"value": "345600s",
"revalidate": null,
"custom": {
"default": "",
"value": ""
},
"custom_values": {
"codes": [],
"value": []
}
},
"browser_cache_settings": {
"enabled": null,
"control": "default",
"value": "345600s",
"custom": {
"value": ""
}
},
"ignore_cookie": {
"enabled": null
},
"ignoreQueryString": {
"enabled": null,
"control": null,
"value": null
},
"query_params_blacklist": {
"enabled": null,
"value": null
},
"query_params_whitelist": {
"enabled": null,
"value": null
},
"country_acl": {
"enabled": null,
"policy_type": "allow",
"excepted_values": [],
"ip_whitelists": []
},
"ip_address_acl": {
"enabled": null,
"policy_type": "allow",
"excepted_values": [],
"ip_whitelists": []
},
"user_agent_acl": {
"enabled": null,
"policy_type": "allow",
"excepted_values": [],
"ip_whitelists": [],
"casesensitive": false
},
"referrer_acl": {
"enabled": null,
"policy_type": "allow",
"noreferer": false,
"excepted_values": [],
"ip_whitelists": []
},
"secure_key": {
"enabled": null,
"policy_type": 0,
"session": 0,
"key": "",
"ip_whitelists": [],
"type": false
},
"limit_bandwidth": {
"enabled": null,
"limit_type": "static",
"speed": 12000,
"buffer": 1024
},
"limit_request": {
"enabled": null,
"rate": 9,
"burst": 98,
"delay": 96,
"ip_whitelists": []
},
"rewrite": {
"enabled": null,
"body": "",
"flag": "break"
},
"host_redirect": {
"enabled": null,
"to": "",
"value": []
},
"redirect_http_to_https": {
"enabled": null
},
"follow_origin_redirect": {
"enabled": null,
"codes": []
},
"hsts": {
"enabled": null,
"referrerPolicy": "no-referrer",
"includeSubDomains": true,
"preload": true
},
"xff": {
"enabled": null
},
"sni": {
"enabled": null,
"sni_type": "dynamic",
"custom_hostname": ""
},
"force_return": {
"enabled": null,
"code": 200,
"body": ""
},
"stale": {
"enabled": null,
"value": ""
},
"staticHeaders": {
"enabled": null,
"keys": [],
"values": []
},
"staticRequestHeaders": {
"enabled": null,
"keys": [],
"values": []
},
"response_headers_hiding_policy": {
"enabled": null,
"mode": "hide",
"expected": {
"hide": [],
"show": []
}
},
"hostHeader": {
"enabled": null,
"control": "forward",
"custom": ""
},
"forward_host_header": {
"enabled": null
},
"cors": {
"enabled": null,
"control": "*",
"always": false,
"value": "*",
"custom": ""
}
}
}`)
req, err := http.NewRequest("POST", "https://api.5centscdn.com/v2/zones/vod/pull/12345/rules/rule", 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/pull/12345/rules/rule')
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 = '{
"_METHOD": "PUT",
"name": "Cache Segments",
"rule": "/stream/*",
"options": {
"edge_cache_settings": {
"enabled": null,
"control": "default",
"default": "345600s",
"value": "345600s",
"revalidate": null,
"custom": {
"default": "",
"value": ""
},
"custom_values": {
"codes": [],
"value": []
}
},
"midgress_cache_settings": {
"enabled": null,
"control": "default",
"default": "345600s",
"value": "345600s",
"revalidate": null,
"custom": {
"default": "",
"value": ""
},
"custom_values": {
"codes": [],
"value": []
}
},
"browser_cache_settings": {
"enabled": null,
"control": "default",
"value": "345600s",
"custom": {
"value": ""
}
},
"ignore_cookie": {
"enabled": null
},
"ignoreQueryString": {
"enabled": null,
"control": null,
"value": null
},
"query_params_blacklist": {
"enabled": null,
"value": null
},
"query_params_whitelist": {
"enabled": null,
"value": null
},
"country_acl": {
"enabled": null,
"policy_type": "allow",
"excepted_values": [],
"ip_whitelists": []
},
"ip_address_acl": {
"enabled": null,
"policy_type": "allow",
"excepted_values": [],
"ip_whitelists": []
},
"user_agent_acl": {
"enabled": null,
"policy_type": "allow",
"excepted_values": [],
"ip_whitelists": [],
"casesensitive": false
},
"referrer_acl": {
"enabled": null,
"policy_type": "allow",
"noreferer": false,
"excepted_values": [],
"ip_whitelists": []
},
"secure_key": {
"enabled": null,
"policy_type": 0,
"session": 0,
"key": "",
"ip_whitelists": [],
"type": false
},
"limit_bandwidth": {
"enabled": null,
"limit_type": "static",
"speed": 12000,
"buffer": 1024
},
"limit_request": {
"enabled": null,
"rate": 9,
"burst": 98,
"delay": 96,
"ip_whitelists": []
},
"rewrite": {
"enabled": null,
"body": "",
"flag": "break"
},
"host_redirect": {
"enabled": null,
"to": "",
"value": []
},
"redirect_http_to_https": {
"enabled": null
},
"follow_origin_redirect": {
"enabled": null,
"codes": []
},
"hsts": {
"enabled": null,
"referrerPolicy": "no-referrer",
"includeSubDomains": true,
"preload": true
},
"xff": {
"enabled": null
},
"sni": {
"enabled": null,
"sni_type": "dynamic",
"custom_hostname": ""
},
"force_return": {
"enabled": null,
"code": 200,
"body": ""
},
"stale": {
"enabled": null,
"value": ""
},
"staticHeaders": {
"enabled": null,
"keys": [],
"values": []
},
"staticRequestHeaders": {
"enabled": null,
"keys": [],
"values": []
},
"response_headers_hiding_policy": {
"enabled": null,
"mode": "hide",
"expected": {
"hide": [],
"show": []
}
},
"hostHeader": {
"enabled": null,
"control": "forward",
"custom": ""
},
"forward_host_header": {
"enabled": null
},
"cors": {
"enabled": null,
"control": "*",
"always": false,
"value": "*",
"custom": ""
}
}
}'
response = http.request(request)
puts response.body
{
"result": "success",
"message": "Zone EdgeRule Created. Please wait till the rules validation & deployment completes.",
"ruleid": 8421
}
{
"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/pull/{zoneId}/rules/rulePOST
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
Content-Typestring
RequiredThe media type of the request body
Options: application/json
_METHODstring
RequiredHTTP method override. Always "PUT" for create.
Options: PUT
namestring
RequiredHuman-readable label for the rule.
rulestring
RequiredURL pattern or regex applied to incoming requests. Validated via /validate/rule.
optionsobject
RequiredContainer for all behavior option groups.
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
rulestring
RequiredURL pattern or regex applied to incoming requests. Validated via /validate/rule.
Example:
/stream/*optionsobject
RequiredContainer for all behavior option groups.
edge_cache_settingsobject
Controls how long the edge CDN caches content.
custom_valuesobject
Per-path-pattern cache overrides.
midgress_cache_settingsobject
Controls midgress (mid-tier) cache duration. Identical structure to edge_cache_settings.
customobject
defaultstring
Example:
valuestring
Example:
custom_valuesobject
codesarray
Example:
[]valuearray
Example:
[]browser_cache_settingsobject
Controls Cache-Control headers sent to the client browser.
controlstring
"default" uses default duration; "no-cache" disables browser caching; "custom" uses custom.value.
Allowed values:
defaultno-cachecustomignoreQueryStringobject
Controls whether query strings are considered when caching. Mutually exclusive with query_params_blacklist and query_params_whitelist. Pull only.
controlstring
"ignore" = strip all query strings before caching; "cache" = include full query string in cache key.
Example:
nullquery_params_blacklistobject
Exclude specific query parameters from the cache key. Mutually exclusive with ignoreQueryString and query_params_whitelist. Pull only.
query_params_whitelistobject
Include only specific query parameters in the cache key. Mutually exclusive with ignoreQueryString and query_params_blacklist. Pull only.
valuestring
Comma-separated query parameter names to keep in the cache key. All others are stripped.
Example:
nullcountry_aclobject
Allow or block requests from specific countries.
policy_typestring
"allow" = whitelist mode (only listed countries allowed); "deny" = blacklist mode.
Allowed values:
allowdenyip_address_aclobject
Allow or block requests from specific IP addresses.
user_agent_aclobject
Allow or block requests based on the User-Agent header.
referrer_aclobject
Allow or block requests based on the Referer header.
secure_keyobject
Protect content with signed URL tokens.
limit_bandwidthobject
Per-connection download speed throttling.
limit_typestring
"static" = fixed speed; "dynamic" = after an initial burst buffer.
Allowed values:
staticdynamicbufferinteger
Initial buffer in KB before speed limit kicks in (used with limit_type "dynamic").
Example:
1024limit_requestobject
Per-IP request rate limiting.
rewriteobject
URL rewrite rule applied before forwarding to origin.
flagstring
"break" stops further processing, "last" re-evaluates, "redirect" returns 302, "permanent" returns 301.
Allowed values:
breaklastredirectpermanenthost_redirectobject
Redirect requests to a different hostname.
redirect_http_to_httpsobject
Permanently redirect all HTTP requests to HTTPS (301).
follow_origin_redirectobject
Follow HTTP redirects returned by the origin. Pull only.
codesarray
HTTP redirect status codes from origin that the CDN should follow and cache the result.
Example:
[]hstsobject
HTTP Strict Transport Security configuration.
referrerPolicystring
Sets the Referrer-Policy header.
Allowed values:
no-referrerno-referrer-when-downgradeoriginorigin-when-cross-originsame-originstrict-originstrict-origin-when-cross-originunsafe-urlxffobject
Add the X-Forwarded-For header with the client IP when forwarding to origin. Pull only.
sniobject
SNI hostname used in TLS handshake toward origin. Pull only.
sni_typestring
"dynamic" = use the incoming request hostname as SNI; "custom" = use custom_hostname.
Allowed values:
dynamiccustomforce_returnobject
Return a fixed HTTP status code for matched requests.
staleobject
Serve stale cached content if origin is unreachable.
staticHeadersobject
Add or override response headers.
staticRequestHeadersobject
Adds or overrides headers on the request forwarded to origin. Pull only.
keysarray
Header names to add/override in the request to origin. Parallel-indexed with values.
Example:
[]response_headers_hiding_policyobject
Suppress specific response headers before delivery to the client. Pull only.
modestring
"hide" = remove listed headers from response; "show" = remove all except listed.
Allowed values:
hideshowhostHeaderobject
Controls the Host header sent to origin. Pull only. Send alongside forward_host_header which is its legacy alias.
controlstring
"forward" = forward the client original Host header; "custom" = use the custom value below.
Allowed values:
forwardcustomforward_host_headerobject
Legacy alias for the Host Header setting. Send alongside hostHeader. Pull only.
corsobject
CORS header support.
Responses
resultstring
RequiredStatus of the API response.
Allowed values:
successmessagestring
Requiredruleidinteger
RequiredThe numeric ID of the newly created edge rule.
resultstring
RequiredAllowed values:
errormessagestring
Requiredresultstring
Allowed values:
errormessagestring
Was this page helpful?