HTTP PullCreate Rule

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/http/pull/12345/rules/rule" \
  -H "Content-Type: application/json" \
  -H "X-API-Key: YOUR_API_KEY" \
  -d '{
  "_METHOD": "PUT",
  "name": "Cache Images",
  "rule": "/images/*",
  "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
    },
    "segmenter_cache_settings": {
      "enabled": null,
      "midgress_manifest": "",
      "edge_manifest": "",
      "midgress_segment": "",
      "edge_segment": ""
    },
    "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
    },
    "gzipOn": {
      "enabled": null
    },
    "fetch_compressed": {
      "enabled": null
    },
    "brotli_compression": {
      "enabled": null,
      "value": ""
    },
    "slice": {
      "enabled": null
    },
    "limit_bandwidth": {
      "enabled": null,
      "limit_type": "static",
      "speed": 12000,
      "buffer": 1024
    },
    "disposition": {
      "enabled": null,
      "value": 0
    },
    "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
    },
    "allowedHttpMethods": {
      "enabled": null,
      "value": 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": ""
    },
    "image_stack": {
      "enabled": null,
      "quality": "Disabled",
      "webp": "Disabled",
      "avif": "Disabled",
      "png_loseless": "true"
    },
    "asset_stack": {
      "enabled": null,
      "combine_css": false,
      "MaxCombinedCssBytes": -1,
      "flatten_css_imports": false,
      "CssFlattenMaxBytes": null,
      "inline_css": false,
      "CssInlineMaxBytes": null,
      "outline_css": false,
      "CssOutlineMinBytes": null,
      "rewrite_css": false,
      "fallback_rewrite_css_urls": false,
      "combine_javascript": false,
      "MaxCombinedJsBytes": null,
      "defer_javascript": false,
      "inline_javascript": false,
      "JsInlineMaxBytes": null,
      "rewrite_javascript": false,
      "outline_javascript": false,
      "JsOutlineMinBytes": null,
      "collapse_whitespace": false,
      "remove_comments": false,
      "remove_quotes": false,
      "CombineAcrossPaths": false
    },
    "cms": {
      "enabled": null,
      "value": []
    },
    "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
    },
    "honor_vary": {
      "enabled": null
    },
    "cors": {
      "enabled": null,
      "control": "*",
      "always": false,
      "value": "*",
      "custom": ""
    }
  }
}'

{
  "result": "success",
  "message": "Zone EdgeRule Created. Please wait till the rules validation & deployment completes.",
  "ruleid": 8408
}
POST
/zones/http/pull/{zoneId}/rules/rule
POST
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

Content-Typestring
Required

The media type of the request body

Options: application/json
_METHODstring
Required

HTTP method override. Always "PUT" for create.

Options: PUT
namestring
Required

Human-readable label for the rule.

rulestring
Required

URL pattern or regex applied to incoming requests. Validated via /validate/rule.

optionsobject
Required

Container for all behavior option groups.

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


Body
application/json
_METHODstring
Required
HTTP method override. Always "PUT" for create.
Allowed values:PUT
namestring
Required
Human-readable label for the rule.
Example:
Cache Images
rulestring
Required
URL pattern or regex applied to incoming requests. Validated via /validate/rule.
Example:
/images/*
optionsobject
Required
Container for all behavior option groups.


Responses
 


resultstring
Required
Status of the API response.
Allowed values:success
messagestring
Required
ruleidinteger
Required
The numeric ID of the newly created edge rule.
Was this page helpful?