Create Zone
Create a new VOD pull Zone
curl -X POST "https://api.5centscdn.com/v2/zones/vod/pull/new" \
-H "Content-Type: application/json" \
-H "X-API-Key: YOUR_API_KEY" \
-d '{
"_METHOD": "PUT",
"alias": "my-vod-pull-zone",
"origin": "https://origin.example.com",
"optimize": "http",
"ssl": {
"http2": "Y",
"redirect": "N",
"mode": "S"
},
"cache": {
"cache": "1d",
"expiry": ""
},
"cnames": "cdn.example.com",
"domainlock": {
"enabled": "N",
"policy": "Y",
"list": "",
"ips": "",
"noreferer": "N"
},
"geoblock": {
"enabled": "N",
"policy": "Y",
"list": [],
"ips": ""
},
"bwlimit": {
"enabled": "N",
"policy": "0",
"rate": 0,
"rateafter": 0
},
"ipaccess": {
"enabled": "N",
"policy": "Y",
"list": "",
"ips": ""
},
"securetoken": {
"enabled": "N",
"policy": "Q",
"keyip": "N",
"list": "",
"timeout": 5,
"session": "0",
"ips": ""
},
"useragent": {
"enabled": "N",
"policy": "Y",
"list": "",
"ips": "",
"casesensitive": "N"
}
}'
import requests
import json
url = "https://api.5centscdn.com/v2/zones/vod/pull/new"
headers = {
"Content-Type": "application/json",
"X-API-Key": "YOUR_API_KEY"
}
data = {
"_METHOD": "PUT",
"alias": "my-vod-pull-zone",
"origin": "https://origin.example.com",
"optimize": "http",
"ssl": {
"http2": "Y",
"redirect": "N",
"mode": "S"
},
"cache": {
"cache": "1d",
"expiry": ""
},
"cnames": "cdn.example.com",
"domainlock": {
"enabled": "N",
"policy": "Y",
"list": "",
"ips": "",
"noreferer": "N"
},
"geoblock": {
"enabled": "N",
"policy": "Y",
"list": [],
"ips": ""
},
"bwlimit": {
"enabled": "N",
"policy": "0",
"rate": 0,
"rateafter": 0
},
"ipaccess": {
"enabled": "N",
"policy": "Y",
"list": "",
"ips": ""
},
"securetoken": {
"enabled": "N",
"policy": "Q",
"keyip": "N",
"list": "",
"timeout": 5,
"session": "0",
"ips": ""
},
"useragent": {
"enabled": "N",
"policy": "Y",
"list": "",
"ips": "",
"casesensitive": "N"
}
}
response = requests.post(url, headers=headers, json=data)
print(response.json())
const response = await fetch("https://api.5centscdn.com/v2/zones/vod/pull/new", {
method: "POST",
headers: {
"Content-Type": "application/json",
"X-API-Key": "YOUR_API_KEY"
},
body: JSON.stringify({
"_METHOD": "PUT",
"alias": "my-vod-pull-zone",
"origin": "https://origin.example.com",
"optimize": "http",
"ssl": {
"http2": "Y",
"redirect": "N",
"mode": "S"
},
"cache": {
"cache": "1d",
"expiry": ""
},
"cnames": "cdn.example.com",
"domainlock": {
"enabled": "N",
"policy": "Y",
"list": "",
"ips": "",
"noreferer": "N"
},
"geoblock": {
"enabled": "N",
"policy": "Y",
"list": [],
"ips": ""
},
"bwlimit": {
"enabled": "N",
"policy": "0",
"rate": 0,
"rateafter": 0
},
"ipaccess": {
"enabled": "N",
"policy": "Y",
"list": "",
"ips": ""
},
"securetoken": {
"enabled": "N",
"policy": "Q",
"keyip": "N",
"list": "",
"timeout": 5,
"session": "0",
"ips": ""
},
"useragent": {
"enabled": "N",
"policy": "Y",
"list": "",
"ips": "",
"casesensitive": "N"
}
})
});
const data = await response.json();
console.log(data);
package main
import (
"fmt"
"net/http"
"bytes"
"encoding/json"
)
func main() {
data := []byte(`{
"_METHOD": "PUT",
"alias": "my-vod-pull-zone",
"origin": "https://origin.example.com",
"optimize": "http",
"ssl": {
"http2": "Y",
"redirect": "N",
"mode": "S"
},
"cache": {
"cache": "1d",
"expiry": ""
},
"cnames": "cdn.example.com",
"domainlock": {
"enabled": "N",
"policy": "Y",
"list": "",
"ips": "",
"noreferer": "N"
},
"geoblock": {
"enabled": "N",
"policy": "Y",
"list": [],
"ips": ""
},
"bwlimit": {
"enabled": "N",
"policy": "0",
"rate": 0,
"rateafter": 0
},
"ipaccess": {
"enabled": "N",
"policy": "Y",
"list": "",
"ips": ""
},
"securetoken": {
"enabled": "N",
"policy": "Q",
"keyip": "N",
"list": "",
"timeout": 5,
"session": "0",
"ips": ""
},
"useragent": {
"enabled": "N",
"policy": "Y",
"list": "",
"ips": "",
"casesensitive": "N"
}
}`)
req, err := http.NewRequest("POST", "https://api.5centscdn.com/v2/zones/vod/pull/new", 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/new')
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",
"alias": "my-vod-pull-zone",
"origin": "https://origin.example.com",
"optimize": "http",
"ssl": {
"http2": "Y",
"redirect": "N",
"mode": "S"
},
"cache": {
"cache": "1d",
"expiry": ""
},
"cnames": "cdn.example.com",
"domainlock": {
"enabled": "N",
"policy": "Y",
"list": "",
"ips": "",
"noreferer": "N"
},
"geoblock": {
"enabled": "N",
"policy": "Y",
"list": [],
"ips": ""
},
"bwlimit": {
"enabled": "N",
"policy": "0",
"rate": 0,
"rateafter": 0
},
"ipaccess": {
"enabled": "N",
"policy": "Y",
"list": "",
"ips": ""
},
"securetoken": {
"enabled": "N",
"policy": "Q",
"keyip": "N",
"list": "",
"timeout": 5,
"session": "0",
"ips": ""
},
"useragent": {
"enabled": "N",
"policy": "Y",
"list": "",
"ips": "",
"casesensitive": "N"
}
}'
response = http.request(request)
puts response.body
{
"result": "success",
"message": "Zone updated successfully",
"zone": {
"type": "pull",
"id": 12345,
"serviceid": 67890,
"mode": "http",
"cnames": "",
"edgeruleids": 0,
"deleted": null,
"name": "my-cdn-zone",
"hashid": "abc123def456",
"fqdn": "cdn.example.com",
"fqdnVoD": "vod.example.com",
"edgerules": {
"enabled": "N"
},
"domainlock": {
"policy": "N",
"list": "example.com,cdn.example.com",
"ips": "203.0.113.10",
"noreferer": "N",
"type": "push",
"enabled": "N",
"active": "N"
},
"geoblock": {
"policy": "N",
"list": [
"US",
"GB"
],
"ips": "203.0.113.10",
"enabled": "N",
"active": "N"
},
"securetoken": {
"policy": "F",
"keyip": "N",
"list": "ab12cd34ef56gh78",
"timeout": 3600,
"session": "0",
"ips": "",
"dirs": "",
"enabled": "N",
"active": "N"
},
"eac": {
"policy": "N",
"list": "http://example.com/auth.script",
"ips": "203.0.113.10",
"enabled": "N",
"active": "N"
},
"ssl": {
"http": "N",
"http2": "Y",
"redirect": "Y",
"mode": "S",
"certid": null,
"zerossl": null,
"enabled": "Y",
"warning": false
},
"cache": {
"smart": "0",
"cache": "4h",
"expiry": "1M",
"querystring": "N",
"cachecontrol": "Y",
"usestale": "Y",
"revalidate": "Y",
"cacheInSecs": 14400,
"cacheInMins": 240,
"expiryInSecs": 2592000,
"expiryInMins": 43200
},
"edge": {
"compression": "N",
"compressionlevel": 5,
"disposition": "N",
"stripcookie": "N",
"xff": "N",
"cors": "Y",
"webp": "N",
"pseudostreaming": "N",
"wp": "N",
"lfo": "Y",
"prefresh": "N"
},
"shield": {
"shields": [
"CA",
"FR"
]
},
"waf": {
"enabled": "N"
},
"seo": {
"id": 12345,
"type": "pull",
"canonical": "N",
"mode": "default",
"robots": "N",
"robotstxt": "N",
"robotstxtcustom": ""
},
"ftpdetails": {
"username": "user_67890_push_12345",
"password": "••••••••"
},
"ssl_enabled": "Y"
},
"warnings": []
}
/zones/vod/pull/new
Target server for requests. Edit to use your own host.
API key (sent in header)
The media type of the request body
Must always be PUT.
Label for the zone.
Origin server URL. Required.
Content delivery optimization mode. http = Standard web content optimization. live = HLS/DASH live streaming optimization. vod = HLS/DASH Video on Demand optimization.
SSL certificate settings for HTTPS delivery.
Cache configuration settings for the zone.
Comma-separated CNAMEs.
Domain lock / referrer restriction settings.
Geo-blocking settings to restrict access by country.
Bandwidth limit settings for the zone.
IP access control settings to allow or block specific IPs.
Secure token settings for URL authentication.
User-agent filter settings to restrict access by browser/client.
Request Preview
Response
Response will appear here after sending the request
Authentication
API Key for authentication. Provide your API key in the header.
Body
Content delivery optimization mode. http = Standard web content optimization. live = HLS/DASH live streaming optimization. vod = HLS/DASH Video on Demand optimization.
httplivevodSSL certificate settings for HTTPS delivery.
Enforce HTTPS via 301 redirect. Y = redirect HTTP to HTTPS. N = allow both HTTP and HTTPS.
YNSSL certificate mode. N = None (no SSL). S = Shared wildcard SSL certificate. L = Free SSL via ZeroSSL/Let's Encrypt. C = Custom SSL certificate.
NSLCCache configuration settings for the zone.
Domain lock / referrer restriction settings.
Referrer filtering mode. Y = Blacklist mode (block requests with listed referring domains). N = Whitelist mode (allow only requests from listed referring domains, block all others).
YNControls requests with no Referer header. Y = block requests that have no Referer header. N = allow requests with no Referer header.
YNGeo-blocking settings to restrict access by country.
Country filtering mode. Y = Blacklist mode (block requests from listed countries). N = Whitelist mode (allow only requests from listed countries, block all others).
YNBandwidth limit settings for the zone.
Rate limiting mode. "0" = Static mode (fixed rate applied from the start of the transfer). "1" = Dynamic mode (rate limiting activates only after rateafter bytes have been served).
01IP access control settings to allow or block specific IPs.
IP access filtering mode. Y = Blacklist mode (block listed IPs). N = Whitelist mode (allow only listed IPs, block all others).
YNSecure token settings for URL authentication.
Defines how the token is computed. Q = Query string mode (token applied per query string parameter). F = Full path mode (token covers the full URL path). D = Directory/path-embedded mode (token is embedded within the URL path).
QFDBind token validation to the originating client IP address. Y = token is only valid from the IP that generated it, preventing sharing or theft. N = IP binding is disabled.
YNDefines the token expiry behavior. "0" = Fixed expiry (token expires at a set time). "1" = Rolling/Moving expiry (token timeout resets with each request for active sessions).
01User-agent filter settings to restrict access by browser/client.
User agent filtering mode. Y = Block mode (block requests from listed user agents). N = Allow mode (allow only requests from listed user agents, block all others).
YNUser agent string matching precision. Y = case-sensitive matching. N = case-insensitive matching.
YNResponses
Status of the API response.
Human-readable status message describing the outcome.
Zone type identifier, e.g. push or pull.
Unique numeric identifier for the zone.
Numeric identifier of the parent CDN service account.
Delivery protocol mode for the zone, e.g. http.
Comma-separated list of custom CNAME hostnames mapped to this zone.
Count of active edge rules assigned to this zone.
Timestamp when the zone was deleted, or null if not deleted.
Auto-generated system name for the zone.
Short alphanumeric hash identifier for the zone.
Fully qualified domain name assigned to the zone by the CDN.
Fully qualified VoD domain name assigned to the zone by the CDN.
Whether edge rules are enabled for this zone. Y means enabled, N means disabled.
Referrer filtering mode. Y = Blacklist mode (block requests with listed referring domains). N = Whitelist mode (allow only requests from listed referring domains, block all others).
Comma-separated domain names to block (Y) or allow (N).
Comma-separated IP addresses excluded from domain lock restrictions regardless of the policy.
Controls requests with no Referer header. Y = block requests that have no Referer header. N = allow requests with no Referer header.
Zone type identifier, e.g. push or pull.
Whether domain lock is enabled. Y means enabled, N means disabled.
Whether domain lock is currently active. Y means active, N means inactive.
Country filtering mode. Y = Blacklist mode (block requests from listed countries). N = Whitelist mode (allow only requests from listed countries, block all others).
Array of ISO-3166 country codes to allow or block.
Comma-separated IP addresses excluded from geo-blocking restrictions.
Whether geo-blocking is enabled. Y means enabled, N means disabled.
Whether geo-blocking is currently active. Y means active, N means inactive.
Defines how the token is computed. Q = Query string mode (token applied per query string parameter). F = Full path mode (token covers the full URL path). D = Directory/path-embedded mode (token is embedded within the URL path).
Whether client IP is bound to the token. Y = token is only valid from the originating client IP. N = IP binding is disabled.
16-character hexadecimal secret key used for token generation.
Token expiry time in seconds. Minimum 5, maximum 25200.
Token expiry behavior. "0" = Fixed expiry (token expires at a set time). "1" = Rolling/Moving expiry (token timeout resets with each request for active sessions).
Comma-separated IP addresses excluded from secure token validation.
Optional directory restriction path for secure token enforcement.
Whether secure token is enabled. Y means enabled, N means disabled.
Whether secure token is currently active. Y means active, N means inactive.
Access policy. Y means allow authenticated requests, N means deny.
Authentication URL for the external access control endpoint.
Comma-separated IP addresses excluded from external access control.
Whether external access control is enabled. Y means enabled, N means disabled.
Whether external access control is currently active. Y means active, N means inactive.
Whether HTTP delivery is enabled alongside HTTPS. Y means enabled.
Whether HTTP/2 protocol is enabled. Y means enabled, N means disabled.
Whether HTTP traffic is automatically redirected to HTTPS.
SSL mode. S = shared/SNI, L = Lets Encrypt, C = custom certificate.
Identifier of the custom SSL certificate assigned to this zone, or null if none.
ZeroSSL certificate provisioning details, or null if not provisioned.
Whether SSL is enabled for this zone. Y means enabled, N means disabled.
SSL configuration warning message, or false if no warnings exist.
Smart cache flag. 1 means enabled, 0 means disabled.
Edge cache TTL duration code, e.g. 4h or 1d.
Browser cache TTL duration code, e.g. 1M. Empty string disables it.
Whether query strings are included in cache keys. Y means included.
Whether Cache-Control headers from origin are respected.
Whether stale cached content is served when origin is unavailable.
Whether conditional revalidation is performed before serving cached content.
Edge cache TTL in seconds.
Edge cache TTL in minutes.
Browser cache TTL in seconds.
Browser cache TTL in minutes.
Whether Gzip/Brotli compression is enabled. Y means enabled.
Compression level from 1 (fastest) to 9 (best compression).
Whether Content-Disposition header is sent to force file download.
Whether cookies are stripped from requests to the CDN edge.
Whether the X-Forwarded-For header is forwarded to the origin.
Whether CORS headers are added to responses. Y means enabled.
Whether automatic WebP image conversion is enabled.
Whether pseudo-streaming for progressive media files is enabled.
Whether WordPress optimizations are enabled.
Whether large file optimization is enabled.
Whether prefresh (background cache refresh) is enabled.
Array of ISO country codes where edge shield nodes are active.
Whether WAF is enabled for this zone. Y means enabled, N means disabled.
Unique numeric identifier for the zone.
Zone type identifier, e.g. push or pull.
Canonical URL setting for SEO optimization.
SEO mode setting for this zone.
Robots meta tag value, e.g. index or noindex.
Robots.txt mode setting.
Custom robots.txt content when mode is set to custom.
FTP username for authenticating to the push zone storage.
FTP password for authenticating to the push zone storage.
Indicates whether SSL is enabled for this zone.
Array of non-fatal warning messages from the operation.