Create Rule

API key (sent in header)

path

zoneIdinteger

Numeric ID of the zone

Content-Typestring

The media type of the request body

Options: application/json

_METHODstring

HTTP method override. Always "PUT" for create.

Options: PUT

namestring

Human-readable label for the rule.

rulestring

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

optionsobject

Container for all behavior option groups.

Request Preview

Response

Response will appear here after sending the request

Authentication

header

X-API-Keystring

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

Path Parameters

zoneIdinteger

Numeric ID of the zone

Example:

12345

Body

application/json

_METHODstring

HTTP method override. Always "PUT" for create.

Allowed values:PUT

namestring

Human-readable label for the rule.

Example:

Cache Images

rulestring

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

Example:

/images/*

optionsobject

edge_cache_settingsobject

Container for all behavior option groups.

Controls how long the edge CDN caches content.

true = active, false = disabled, null = inherit from default.

Example:

null

Selects which cache duration mode applies.

Allowed values:defaultvalueno-cache

defaultstring

Duration used when control is "default".

Example:

345600s

Duration used when control is "value".

Example:

345600s

revalidatestring

Revalidation time directive.

Example:

null

customobject

defaultstring

Custom pattern default value.

Example:

midgress_cache_settingsobject

Custom pattern override value.

Example:

custom_valuesobject

Per-path-pattern cache overrides.

codesarray

Each inner array is a list of path patterns for one override rule.

Example:

[]

valuearray

Cache duration per override group, parallel-indexed with codes.

Example:

[]

Controls midgress (mid-tier) cache duration. Identical structure to edge_cache_settings.

Inherit / enable / disable.

Example:

null

"default" or "value".

Allowed values:defaultvalue

defaultstring

Duration for default mode.

Example:

345600s

browser_cache_settingsobject

Duration for value mode.

Example:

345600s

revalidatestring

Revalidation directive.

Example:

null

Example:

Example:

Example:

[]

valuearray

Example:

[]

Controls Cache-Control headers sent to the client browser.

Inherit / enable / disable.

Example:

null

"default" uses default duration; "no-cache" disables browser caching; "custom" uses custom.value.

Allowed values:defaultno-cachecustom

Duration when control is "default".

Example:

345600s

customobject

Duration when control is "custom".

Example:

country_aclobject

Allow or block requests from specific countries.

Inherit / enable / disable.

Example:

null

"allow" = whitelist mode (only listed countries allowed); "deny" = blacklist mode.

Allowed values:allowdeny

ISO 3166-1 alpha-2 country codes to apply the policy to.

Example:

[]

IPs or CIDR ranges excluded from the country ACL check.

Example:

[]

ip_address_aclobject

Allow or block requests from specific IP addresses.

Inherit / enable / disable.

Example:

null

"allow" or "deny".

Allowed values:allowdeny

IP addresses or CIDR blocks to apply the policy to.

Example:

[]

IPs exempt from this policy.

Example:

[]

user_agent_aclobject

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

Inherit / enable / disable.

Example:

null

"allow" or "deny".

Allowed values:allowdeny

User-agent strings to apply the policy to. Must be non-empty when enabled = true.

Example:

[]

IPs exempt from this policy.

Example:

[]

casesensitiveboolean

Whether string matching is case-sensitive.

Example:

false

referrer_aclobject

Allow or block requests based on the Referer header.

Inherit / enable / disable.

Example:

null

"allow" or "deny".

Allowed values:allowdeny

norefererboolean

Whether to also apply the policy to requests with no Referer header.

Example:

false

Referer domain values. Must be non-empty when enabled = true.

Example:

[]

IPs exempt from this policy.

Example:

[]

secure_keyobject

Protect content with signed URL tokens.

Inherit / enable / disable.

Example:

null

policy_typeinteger

Token algorithm. 0 = MD5, 1 = SHA1, 2 = SHA256.

Allowed values:012

sessioninteger

Session expiry mode. 0 = disabled.

Example:

0

keystring

The secret signing key. Must be non-empty when enabled = true.

Example:

IPs allowed without token validation.

Example:

[]

typeboolean

false = standard token, true = advanced mode.

Example:

false

gzipOnobject

Enable edge GZip compression of responses.

true = active, false = disabled, null = inherit from default.

Example:

null

fetch_compressedobject

Request compressed content from origin.

Inherit / enable / disable.

Example:

null

brotli_compressionobject

Enable Brotli compression.

Inherit / enable / disable.

Example:

null

Compression level or mode.

Example:

sliceobject

Splits large files into slices for parallel delivery.

Inherit / enable / disable.

Example:

null

limit_bandwidthobject

Per-connection download speed throttling.

Inherit / enable / disable.

Example:

null

limit_typestring

"static" = fixed speed; "dynamic" = after an initial burst buffer.

Allowed values:staticdynamic

speedinteger

Speed cap in bytes/second.

Example:

12000

bufferinteger

Initial buffer in KB before the speed limit kicks in (used with limit_type "dynamic").

Example:

1024

dispositionobject

Sets Content-Disposition attachment on responses.

Inherit / enable / disable.

Example:

null

valueinteger

0 = use filename from URL; any positive integer = custom expiry variant.

Example:

0

limit_requestobject

Per-IP request rate limiting.

Inherit / enable / disable.

Example:

null

rateinteger

Allowed requests per second per client.

Example:

9

burstinteger

Burst capacity (additional requests allowed above rate).

Example:

98

delayinteger

Requests delayed before rejection kicks in.

Example:

96

IPs exempt from rate limiting.

Example:

[]

rewriteobject

URL rewrite rule applied before forwarding to origin.

Inherit / enable / disable.

Example:

null

bodystring

The rewrite rule body (nginx-style rewrite expression).

Example:

flagstring

"break" stops further rule processing, "last" re-evaluates from first rule, "redirect" returns 302, "permanent" returns 301.

Allowed values:breaklastredirectpermanent

host_redirectobject

Redirect requests to a different hostname.

redirect_http_to_httpsobject

Inherit / enable / disable.

Example:

null

tostring

The target hostname to redirect to.

Example:

valuearray

Additional redirect path mappings.

Example:

[]

Permanently redirect all HTTP requests to HTTPS (301).

Inherit / enable / disable.

Example:

null

hstsobject

HTTP Strict Transport Security configuration.

Inherit / enable / disable.

Example:

null

referrerPolicystring

Sets the Referrer-Policy header.

Allowed values:no-referrerno-referrer-when-downgradeoriginorigin-when-cross-originsame-originstrict-originstrict-origin-when-cross-originunsafe-url

includeSubDomainsboolean

Include includeSubDomains directive in HSTS header.

Example:

true

preloadboolean

Include preload directive (required to be on HSTS preload list).

Example:

true

image_stackobject

On-the-fly image optimization.

Inherit / enable / disable.

Example:

null

qualitystring

WebP/AVIF output quality preset.

Allowed values:DisabledLowMediumHigh

webpstring

Auto-convert images to WebP.

Allowed values:DisabledEnabled

avifstring

Auto-convert images to AVIF.

Allowed values:DisabledEnabled

png_loselessstring

Use lossless encoding for PNG. Sent as string, not boolean.

Allowed values:truefalse

asset_stackobject

Web performance optimization for CSS and JavaScript assets. The entire asset_stack object in the final payload is replaced by this.asseststack (set via child component updateRule() emission).

MaxCombinedCssBytesinteger

Inherit / enable / disable.

Example:

null

combine_cssboolean

Combine multiple CSS files into one.

Example:

false

Max size (bytes) for combined CSS. -1 = unlimited.

Example:

-1

flatten_css_importsboolean

Inline @import rules in CSS.

Example:

false

CssFlattenMaxBytesinteger

Max bytes for CSS flattening.

Example:

null

inline_cssboolean

Inline small CSS files into HTML.

Example:

false

CssInlineMaxBytesinteger

Max size of CSS to inline.

Example:

null

outline_cssboolean

Extract inline CSS into external files.

Example:

false

CssOutlineMinBytesinteger

Min size of inline CSS to extract.

Example:

null

rewrite_cssboolean

Rewrite CSS URLs to CDN-hosted paths.

Example:

false

fallback_rewrite_css_urlsboolean

Rewrite CSS URL fallbacks.

Example:

false

combine_javascriptboolean

Combine multiple JS files into one.

Example:

false

MaxCombinedJsBytesinteger

Max size for combined JS.

Example:

null

defer_javascriptboolean

Add defer attribute to script tags.

Example:

false

inline_javascriptboolean

Inline small JS files into HTML.

Example:

false

JsInlineMaxBytesinteger

Max size of JS to inline.

Example:

null

rewrite_javascriptboolean

Rewrite JS source URLs.

Example:

false

outline_javascriptboolean

Extract inline JS into external files.

Example:

false

JsOutlineMinBytesinteger

Min size of inline JS to extract.

Example:

null

collapse_whitespaceboolean

Collapse HTML whitespace.

Example:

false

remove_commentsboolean

Strip HTML comments.

Example:

false

remove_quotesboolean

Remove unnecessary attribute quotes in HTML.

Example:

false

CombineAcrossPathsboolean

Combine assets across different URL paths.

Example:

false

force_returnobject

Return a fixed HTTP status code for matched requests.

Inherit / enable / disable.

Example:

null

codeinteger

HTTP status code to return for matched requests.

Example:

200

bodystring

Response body to return with the forced status code.

Example:

staleobject

Serve stale cached content if origin is unreachable.

Inherit / enable / disable.

Example:

null

How long to serve stale content.

Example:

staticHeadersobject

Add or override response headers.

Inherit / enable / disable.

Example:

null

keysarray

Header names to add/override in the response. Parallel-indexed with values.

Example:

[]

valuesarray

Corresponding header values.

Example:

[]

corsobject

CORS header support.

Inherit / enable / disable.

Example:

null

"*" = wildcard (allow all origins); "custom" = restrict to specific origin.

Example:

*

alwaysboolean

Add CORS headers to all responses including error responses.

Example:

false