List Rules

Returns all configured edge rules for the given zone, together with the zone's default-behavior entries. The response rules array is used to populate the Edge Rules summary table; behaviors contains the single default-behavior object.

curl -X GET "https://api.5centscdn.com/v2/zones/http/pull/12345/rules" \
  -H "Content-Type: application/json" \
  -H "X-API-Key: YOUR_API_KEY"

import requests
import json

url = "https://api.5centscdn.com/v2/zones/http/pull/12345/rules"
headers = {
  "Content-Type": "application/json",
  "X-API-Key": "YOUR_API_KEY"
}

response = requests.get(url, headers=headers)
print(response.json())

const response = await fetch("https://api.5centscdn.com/v2/zones/http/pull/12345/rules", {
  method: "GET",
  headers: {
  "Content-Type": "application/json",
  "X-API-Key": "YOUR_API_KEY"
}
});

const data = await response.json();
console.log(data);

package main

import (
    "fmt"
    "net/http"
)

func main() {

    req, err := http.NewRequest("GET", "https://api.5centscdn.com/v2/zones/http/pull/12345/rules", nil)
    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/http/pull/12345/rules')
http = Net::HTTP.new(uri.host, uri.port)
http.use_ssl = true

request = Net::HTTP::Get.new(uri)
request['Content-Type'] = 'application/json'
request['X-API-Key'] = 'YOUR_API_KEY'

response = http.request(request)
puts response.body

{
  "result": "success",
  "rules": [
    {
      "id": 12345,
      "network": "sample-network",
      "rule": {
        "name": "sample-edge-rule",
        "rule": "/images/*",
        "ruleType": 0,
        "originProtocol": null,
        "isRegex": true,
        "network": "sample-network",
        "options": {
          "ignore_cookie": {
            "enabled": false,
            "value": false
          },
          "honor_vary": {
            "enabled": false,
            "value": false
          },
          "xff": {
            "enabled": false,
            "value": false
          },
          "disposition": {
            "enabled": false,
            "value": 0
          },
          "redirect_http_to_https": {
            "enabled": false,
            "value": false
          },
          "segmenter_cache_settings": {
            "enabled": false,
            "midgress_manifest": 2,
            "edge_manifest": 4,
            "midgress_segment": 1,
            "edge_segment": 3
          },
          "follow_origin_redirect": {
            "enabled": false,
            "codes": []
          },
          "host_redirect": {
            "enabled": true,
            "value": [
              "cdn.example.com"
            ],
            "to": "origin.example.com"
          },
          "gzipOn": {
            "enabled": false,
            "value": false
          },
          "fetch_compressed": {
            "enabled": false,
            "value": false
          },
          "slice": {
            "enabled": false,
            "value": false
          },
          "websockets": {
            "enabled": false,
            "value": false
          },
          "waf": {
            "enabled": false,
            "value": false
          },
          "stale": {
            "enabled": true,
            "value": [
              "error"
            ]
          },
          "brotli_compression": {
            "enabled": true,
            "value": [
              "application/wasm"
            ]
          },
          "response_headers_hiding_policy": {
            "enabled": false,
            "mode": "hide",
            "expected": [
              "connection",
              "server",
              "content-type",
              "content-length",
              "date"
            ],
            "value": []
          },
          "referrer_acl": {
            "enabled": true,
            "policy_type": "allow",
            "excepted_values": [
              ""
            ],
            "ip_whitelists": [
              "203.0.113.1"
            ],
            "noreferer": true
          },
          "country_acl": {
            "enabled": true,
            "policy_type": "allow",
            "excepted_values": [
              ""
            ],
            "ip_whitelists": [
              "203.0.113.1",
              "203.0.113.2"
            ]
          },
          "ip_address_acl": {
            "enabled": true,
            "policy_type": "allow",
            "excepted_values": [
              "203.0.113.1"
            ],
            "ip_whitelists": [
              "203.0.113.1"
            ]
          },
          "user_agent_acl": {
            "enabled": false,
            "policy_type": "allow",
            "excepted_values": [],
            "ip_whitelists": [],
            "casesensitive": true
          },
          "secure_key": {
            "enabled": false,
            "policy_type": "0",
            "type": 2,
            "key": "",
            "ip_whitelists": [],
            "timeout": "3600",
            "session": 0
          },
          "allowedHttpMethods": {
            "enabled": true,
            "value": [
              "GET",
              "HEAD",
              "POST",
              "PUT",
              "PATCH",
              "DELETE",
              "OPTIONS"
            ]
          },
          "tls_versions": {
            "enabled": false,
            "value": []
          },
          "edge_cache_settings": {
            "enabled": true,
            "revalidate": false,
            "default": "345600s"
          },
          "midgress_cache_settings": {
            "enabled": true,
            "revalidate": false,
            "default": "345600s"
          },
          "browser_cache_settings": {
            "enabled": true
          },
          "cors": {
            "enabled": false,
            "always": false,
            "value": ""
          },
          "sni": {
            "enabled": false
          },
          "force_return": {
            "enabled": true,
            "code": 200,
            "body": "www.example.com"
          },
          "rewrite": {
            "enabled": true,
            "flag": "break",
            "body": "/regex/(.*) /regex/$1"
          },
          "staticRequestHeaders": {
            "enabled": true,
            "value": {
              "X-Custom-Header": "sample-value"
            }
          },
          "staticHeaders": {
            "enabled": true,
            "value": {
              "X-Response-Header": "sample-value"
            }
          },
          "hostHeader": null,
          "forward_host_header": null,
          "limit_bandwidth": {
            "enabled": true,
            "limit_type": "static",
            "speed": "128",
            "buffer": "1024"
          },
          "limit_request": {
            "enabled": true,
            "rate": "0",
            "burst": "0",
            "delay": "0",
            "ip_whitelists": [
              "203.0.113.1"
            ]
          },
          "hsts": {
            "enabled": false,
            "referrerPolicy": "no-referrer-when-downgrade",
            "includeSubDomains": true,
            "preload": true
          },
          "cms": {
            "enabled": false,
            "value": []
          },
          "image_stack": null,
          "asset_stack": null,
          "ignoreQueryString": {
            "enabled": false,
            "value": false
          },
          "query_params_blacklist": {
            "enabled": false,
            "value": false
          },
          "query_params_whitelist": {
            "enabled": false,
            "value": false
          }
        }
      }
    }
  ],
  "behaviors": [
    {
      "id": 12346,
      "network": "sample-network",
      "rule": {
        "name": "default",
        "rule": "/",
        "ruleType": 0,
        "originProtocol": null,
        "isRegex": false,
        "network": "sample-network",
        "options": {
          "ignore_cookie": {
            "enabled": true,
            "value": true
          },
          "honor_vary": {
            "enabled": false,
            "value": false
          },
          "xff": {
            "enabled": false,
            "value": false
          },
          "disposition": {
            "enabled": false,
            "value": 0
          },
          "redirect_http_to_https": {
            "enabled": false,
            "value": false
          },
          "segmenter_cache_settings": {
            "enabled": false,
            "midgress_manifest": 2,
            "edge_manifest": 4,
            "midgress_segment": 1,
            "edge_segment": 3
          },
          "follow_origin_redirect": {
            "enabled": false,
            "codes": []
          },
          "host_redirect": {
            "enabled": false,
            "value": [],
            "to": ""
          },
          "gzipOn": {
            "enabled": false,
            "value": false
          },
          "fetch_compressed": {
            "enabled": false,
            "value": false
          },
          "slice": {
            "enabled": false,
            "value": false
          },
          "websockets": {
            "enabled": false,
            "value": false
          },
          "waf": {
            "enabled": false,
            "value": false
          },
          "stale": {
            "enabled": false,
            "value": []
          },
          "brotli_compression": {
            "enabled": false,
            "value": []
          },
          "response_headers_hiding_policy": {
            "enabled": false,
            "mode": "",
            "expected": null,
            "value": []
          },
          "referrer_acl": {
            "enabled": false,
            "policy_type": "allow",
            "excepted_values": [],
            "ip_whitelists": [],
            "noreferer": false
          },
          "country_acl": {
            "enabled": true,
            "policy_type": "allow",
            "excepted_values": [
              ""
            ],
            "ip_whitelists": []
          },
          "ip_address_acl": {
            "enabled": false,
            "policy_type": "allow",
            "excepted_values": [],
            "ip_whitelists": []
          },
          "user_agent_acl": {
            "enabled": false,
            "policy_type": "allow",
            "excepted_values": [],
            "ip_whitelists": [],
            "casesensitive": false
          },
          "secure_key": {
            "enabled": false,
            "policy_type": null,
            "type": 2,
            "key": "",
            "ip_whitelists": [],
            "timeout": 3600,
            "session": 0
          },
          "allowedHttpMethods": {
            "enabled": false,
            "value": []
          },
          "tls_versions": {
            "enabled": false,
            "value": []
          },
          "edge_cache_settings": {
            "enabled": true,
            "revalidate": false,
            "default": "3600s"
          },
          "midgress_cache_settings": {
            "enabled": true,
            "revalidate": false,
            "default": "3600s"
          },
          "browser_cache_settings": {
            "enabled": true
          },
          "cors": {
            "enabled": false,
            "always": false,
            "value": ""
          },
          "sni": {
            "enabled": false
          },
          "force_return": {
            "enabled": false
          },
          "rewrite": {
            "enabled": false
          },
          "staticRequestHeaders": {
            "enabled": false
          },
          "staticHeaders": {
            "enabled": false
          },
          "hostHeader": null,
          "forward_host_header": null,
          "limit_bandwidth": {
            "enabled": false,
            "limit_type": "dynamic"
          },
          "limit_request": {
            "enabled": false,
            "rate": 0,
            "burst": 0,
            "delay": 0,
            "ip_whitelists": []
          },
          "hsts": {
            "enabled": false,
            "referrerPolicy": "no-referrer",
            "includeSubDomains": false,
            "preload": false
          },
          "cms": {
            "enabled": false,
            "value": []
          },
          "image_stack": null,
          "asset_stack": null,
          "ignoreQueryString": {
            "enabled": true,
            "value": true
          }
        }
      }
    }
  ]
}

{
  "error": "Bad Request",
  "message": "The request contains invalid parameters or malformed data",
  "code": 400,
  "details": [
    {
      "field": "email",
      "message": "Invalid email format"
    }
  ]
}

GET

/zones/http/pull/{zoneId}/rules

GET

Base URLstring

Target server for requests. Edit to use your own host.

API Key (header: X-API-Key)

X-API-Keystring

Required

API key (sent in header)

path

zoneIdinteger

Required

Numeric ID of the zone

Request Preview

Response

Response will appear here after sending the request

Authentication

header

X-API-Keystring

Required

API Key for authentication. Provide your API key in the header.

Path Parameters

zoneIdinteger

Required

Numeric ID of the zone

Example:

12345

Responses

resultstring

Status of the API response.

Allowed values:success

rulesarray

List of edge rules configured for this zone.

idinteger

Unique identifier of this edge rule or default behavior.

networkstring

CDN network provider associated with this rule or behavior.

ruleobject

Rule configuration object containing the match pattern and behavior options.

namestring

Human-readable label for the edge rule.

rulestring

URL pattern or glob applied to incoming requests.

ruleTypeinteger

Rule type identifier. 0 = standard path-based rule.

originProtocolstring

Origin protocol override. Null to inherit from zone settings.

isRegexboolean

When true, the rule pattern uses regular expression syntax.

networkstring

CDN network provider associated with this rule configuration.

optionsobject

Behavior options applied when this rule matches a request.

ignore_cookieobject

Ignore Set-Cookie headers from origin so responses can be cached.

enabledboolean

valueboolean

honor_varyobject

Respect the Vary header from origin when forming cache keys.

enabledboolean

valueboolean

xffobject

Forward the client IP in the X-Forwarded-For header to origin.

enabledboolean

valueboolean

dispositionobject

Control the Content-Disposition header mode for responses.

enabledboolean

valueinteger

redirect_http_to_httpsobject

Automatically redirect HTTP requests to HTTPS.

enabledboolean

valueboolean

segmenter_cache_settingsobject

Override cache durations for HLS manifest and segment files.

enabledboolean

midgress_manifestinteger

edge_manifestinteger

midgress_segmentinteger

edge_segmentinteger

follow_origin_redirectobject

Follow 3xx redirects from origin instead of passing them to clients.

enabledboolean

codesinteger[]

host_redirectobject

Redirect requests matching this rule to a different host.

enabledboolean

valuestring[]

tostring

gzipOnobject

Enable gzip compression for responses.

enabledboolean

valueboolean

fetch_compressedobject

Fetch and serve pre-compressed assets from origin.

enabledboolean

valueboolean

sliceobject

Enable range-request slice caching for large files.

enabledboolean

valueboolean

websocketsobject

Enable WebSocket proxying for matched requests.

enabledboolean

valueboolean

wafobject

Enable Web Application Firewall protection.

enabledboolean

valueboolean

staleobject

Serve stale cached content when specified error conditions occur.

enabledboolean

valuestring[]

brotli_compressionobject

Enable Brotli compression for specified MIME content types.

enabledboolean

valuestring[]

response_headers_hiding_policyobject

Filter or suppress specific response headers before delivery.

enabledboolean

modestring

expectedstring[]

valuestring[]

referrer_aclobject

Allow or block requests based on the HTTP Referer header.

enabledboolean

policy_typestring

excepted_valuesstring[]

ip_whitelistsstring[]

norefererboolean

country_aclobject

Allow or block requests based on the visitor country.

enabledboolean

policy_typestring

excepted_valuesstring[]

ip_whitelistsstring[]

ip_address_aclobject

Allow or block requests based on the client IP address.

enabledboolean

policy_typestring

excepted_valuesstring[]

ip_whitelistsstring[]

user_agent_aclobject

Allow or block requests based on the User-Agent header.

enabledboolean

policy_typestring

excepted_valuesstring[]

ip_whitelistsstring[]

casesensitiveboolean

secure_keyobject

Protect content using time-limited signed URL tokens.

enabledboolean

policy_typestring

typeinteger

keystring

ip_whitelistsstring[]

timeoutstring

sessioninteger

allowedHttpMethodsobject

Restrict which HTTP methods are accepted for requests.

enabledboolean

valuestring[]

tls_versionsobject

Restrict TLS connections to specific protocol versions.

enabledboolean

valuestring[]

edge_cache_settingsobject

Controls how long CDN edge nodes cache content.

enabledboolean

revalidateboolean

defaultstring

midgress_cache_settingsobject

Controls how long CDN mid-tier nodes cache content.

enabledboolean

revalidateboolean

defaultstring

browser_cache_settingsobject

Controls Cache-Control headers sent to the client browser.

enabledboolean

corsobject

Set Cross-Origin Resource Sharing headers on responses.

enabledboolean

alwaysboolean

valuestring

sniobject

Enable Server Name Indication for TLS connections.

enabledboolean

force_returnobject

Return a fixed HTTP status code and optional body for matched requests.

enabledboolean

codeinteger

bodystring

rewriteobject

Rewrite the request URL path using a pattern and replacement.

enabledboolean

flagstring

bodystring

staticRequestHeadersobject

Add static headers to requests forwarded to origin.

enabledboolean

valueobject

staticHeadersobject

Add static headers to responses sent to clients.

enabledboolean

valueobject

hostHeaderstring

Override the Host header sent to origin.

forward_host_headerstring

Forward the original client Host header to origin.

limit_bandwidthobject

Throttle the response bandwidth for matched requests.

enabledboolean

limit_typestring

speedstring

bufferstring

limit_requestobject

Rate-limit requests from each client IP address.

enabledboolean

ratestring

burststring

delaystring

ip_whitelistsstring[]

hstsobject

Set HTTP Strict Transport Security policy headers.

enabledboolean

referrerPolicystring

includeSubDomainsboolean

preloadboolean

cmsobject

Apply caching optimizations for specific CMS platforms.

enabledboolean

valuestring[]

image_stackstring

Enable on-the-fly image optimization.

asset_stackstring

Enable web performance optimizations for CSS and JavaScript assets.

ignoreQueryStringobject

Control how query strings are handled when forming cache keys.

enabledboolean

valueboolean

query_params_blacklistobject

Exclude specific query parameters from the cache key.

enabledboolean

valueboolean

query_params_whitelistobject

Include only specific query parameters in the cache key.

enabledboolean

valueboolean

behaviorsarray

List of default behavior entries for this zone. Typically contains a single default behavior.

idinteger

Unique identifier of this edge rule or default behavior.

networkstring

CDN network provider associated with this rule or behavior.

ruleobject

Rule configuration object containing the match pattern and behavior options.

namestring

Human-readable label for the edge rule.

rulestring

URL pattern or glob applied to incoming requests.

ruleTypeinteger

Rule type identifier. 0 = standard path-based rule.

originProtocolstring

Origin protocol override. Null to inherit from zone settings.

isRegexboolean

When true, the rule pattern uses regular expression syntax.

networkstring

CDN network provider associated with this rule configuration.

optionsobject

Behavior options applied when this rule matches a request.

ignore_cookieobject

Ignore Set-Cookie headers from origin so responses can be cached.

enabledboolean

valueboolean

honor_varyobject

Respect the Vary header from origin when forming cache keys.

enabledboolean

valueboolean

xffobject

Forward the client IP in the X-Forwarded-For header to origin.

enabledboolean

valueboolean

dispositionobject

Control the Content-Disposition header mode for responses.

enabledboolean

valueinteger

redirect_http_to_httpsobject

Automatically redirect HTTP requests to HTTPS.

enabledboolean

valueboolean

segmenter_cache_settingsobject

Override cache durations for HLS manifest and segment files.

enabledboolean

midgress_manifestinteger

edge_manifestinteger

midgress_segmentinteger

edge_segmentinteger

follow_origin_redirectobject

Follow 3xx redirects from origin instead of passing them to clients.

enabledboolean

codesinteger[]

host_redirectobject

Redirect requests matching this rule to a different host.

enabledboolean

valuestring[]

tostring

gzipOnobject

Enable gzip compression for responses.

enabledboolean

valueboolean

fetch_compressedobject

Fetch and serve pre-compressed assets from origin.

enabledboolean

valueboolean

sliceobject

Enable range-request slice caching for large files.

enabledboolean

valueboolean

websocketsobject

Enable WebSocket proxying for matched requests.

enabledboolean

valueboolean

wafobject

Enable Web Application Firewall protection.

enabledboolean

valueboolean

staleobject

Serve stale cached content when specified error conditions occur.

enabledboolean

valuestring[]

brotli_compressionobject

Enable Brotli compression for specified MIME content types.

enabledboolean

valuestring[]

response_headers_hiding_policyobject

Filter or suppress specific response headers before delivery.

enabledboolean

modestring

expectedstring

valuestring[]

referrer_aclobject

Allow or block requests based on the HTTP Referer header.

enabledboolean

policy_typestring

excepted_valuesstring[]

ip_whitelistsstring[]

norefererboolean

country_aclobject

Allow or block requests based on the visitor country.

enabledboolean

policy_typestring

excepted_valuesstring[]

ip_whitelistsstring[]

ip_address_aclobject

Allow or block requests based on the client IP address.

enabledboolean

policy_typestring

excepted_valuesstring[]

ip_whitelistsstring[]

user_agent_aclobject

Allow or block requests based on the User-Agent header.

enabledboolean

policy_typestring

excepted_valuesstring[]

ip_whitelistsstring[]

casesensitiveboolean

secure_keyobject

Protect content using time-limited signed URL tokens.

enabledboolean

policy_typestring

typeinteger

keystring

ip_whitelistsstring[]

timeoutinteger

sessioninteger

allowedHttpMethodsobject

Restrict which HTTP methods are accepted for requests.

enabledboolean

valuestring[]

tls_versionsobject

Restrict TLS connections to specific protocol versions.

enabledboolean

valuestring[]

edge_cache_settingsobject

Controls how long CDN edge nodes cache content.

enabledboolean

revalidateboolean

defaultstring

midgress_cache_settingsobject

Controls how long CDN mid-tier nodes cache content.

enabledboolean

revalidateboolean

defaultstring

browser_cache_settingsobject

Controls Cache-Control headers sent to the client browser.

enabledboolean

corsobject

Set Cross-Origin Resource Sharing headers on responses.

enabledboolean

alwaysboolean

valuestring

sniobject

Enable Server Name Indication for TLS connections.

enabledboolean

force_returnobject

Return a fixed HTTP status code and optional body for matched requests.

enabledboolean

rewriteobject

Rewrite the request URL path using a pattern and replacement.

enabledboolean

staticRequestHeadersobject

Add static headers to requests forwarded to origin.

enabledboolean

staticHeadersobject

Add static headers to responses sent to clients.

enabledboolean

hostHeaderstring

Override the Host header sent to origin.

forward_host_headerstring

Forward the original client Host header to origin.

limit_bandwidthobject

Throttle the response bandwidth for matched requests.

enabledboolean

limit_typestring

limit_requestobject

Rate-limit requests from each client IP address.

enabledboolean

rateinteger

burstinteger

delayinteger

ip_whitelistsstring[]

hstsobject

Set HTTP Strict Transport Security policy headers.

enabledboolean

referrerPolicystring

includeSubDomainsboolean

preloadboolean

cmsobject

Apply caching optimizations for specific CMS platforms.

enabledboolean

valuestring[]

image_stackstring

Enable on-the-fly image optimization.

asset_stackstring

Enable web performance optimizations for CSS and JavaScript assets.

ignoreQueryStringobject

Control how query strings are handled when forming cache keys.

enabledboolean

valueboolean

resultstring

Required

Allowed values:error

messagestring

Required

resultstring

Allowed values:error

messagestring

Was this page helpful?