Skip to content
Cloudflare API
Start here
API Reference
Snippets

Rules

List zone snippet rules
client.snippets.rules.get(RuleGetParams { zone_id } params, RequestOptionsoptions?): SinglePage<RuleGetResponse { id, expression, last_updated, 3 more } >
GET/zones/{zone_id}/snippets/snippet_rules
List zone snippet rules
client.snippets.rules.list(RuleListParams { zone_id } params, RequestOptionsoptions?): SinglePage<RuleListResponse { id, expression, last_updated, 3 more } >
GET/zones/{zone_id}/snippets/snippet_rules
Update zone snippet rules
client.snippets.rules.update(RuleUpdateParams { zone_id, rules } params, RequestOptionsoptions?): SinglePage<RuleUpdateResponse { id, expression, last_updated, 3 more } >
PUT/zones/{zone_id}/snippets/snippet_rules
Delete zone snippet rules
client.snippets.rules.delete(RuleDeleteParams { zone_id } params, RequestOptionsoptions?): SinglePage<RuleDeleteResponse { id, expression, last_updated, 3 more } >
DELETE/zones/{zone_id}/snippets/snippet_rules
ModelsExpand Collapse
RuleGetResponse { id, expression, last_updated, 3 more }

Define a snippet rule.

id: string

Specify the unique ID of the rule.

expression: string

Define the expression that determines which traffic matches the rule.

minLength1
last_updated: string

Specify the timestamp of when the rule was last modified.

formatdate-time
snippet_name: string

Identify the snippet.

description?: string

Provide an informative description of the rule.

enabled?: boolean

Indicate whether to execute the rule.

RuleListResponse { id, expression, last_updated, 3 more }

Define a snippet rule.

id: string

Specify the unique ID of the rule.

expression: string

Define the expression that determines which traffic matches the rule.

minLength1
last_updated: string

Specify the timestamp of when the rule was last modified.

formatdate-time
snippet_name: string

Identify the snippet.

description?: string

Provide an informative description of the rule.

enabled?: boolean

Indicate whether to execute the rule.

RuleUpdateResponse { id, expression, last_updated, 3 more }

Define a snippet rule.

id: string

Specify the unique ID of the rule.

expression: string

Define the expression that determines which traffic matches the rule.

minLength1
last_updated: string

Specify the timestamp of when the rule was last modified.

formatdate-time
snippet_name: string

Identify the snippet.

description?: string

Provide an informative description of the rule.

enabled?: boolean

Indicate whether to execute the rule.

RuleDeleteResponse { id, expression, last_updated, 3 more }

Define a snippet rule.

id: string

Specify the unique ID of the rule.

expression: string

Define the expression that determines which traffic matches the rule.

minLength1
last_updated: string

Specify the timestamp of when the rule was last modified.

formatdate-time
snippet_name: string

Identify the snippet.

description?: string

Provide an informative description of the rule.

enabled?: boolean

Indicate whether to execute the rule.