API Reference

Snippets

Copy Markdown

Open in Claude

Open in ChatGPT

Open in Cursor

---

Copy Markdown

View as Markdown

Rules

List zone snippet rules

snippets.rules.get(RuleGetParams**kwargs) -> SyncSinglePage[RuleGetResponse]

GET/zones/{zone_id}/snippets/snippet_rules

List zone snippet rules

snippets.rules.list(RuleListParams**kwargs) -> SyncSinglePage[RuleListResponse]

GET/zones/{zone_id}/snippets/snippet_rules

Update zone snippet rules

snippets.rules.update(RuleUpdateParams**kwargs) -> SyncSinglePage[RuleUpdateResponse]

PUT/zones/{zone_id}/snippets/snippet_rules

Delete zone snippet rules

snippets.rules.delete(RuleDeleteParams**kwargs) -> SyncSinglePage[RuleDeleteResponse]

DELETE/zones/{zone_id}/snippets/snippet_rules

ModelsExpand Collapse

class RuleGetResponse: …

Define a snippet rule.

id: str

Specify the unique ID of the rule.

expression: str

Define the expression that determines which traffic matches the rule.

minLength1

last_updated: datetime

Specify the timestamp of when the rule was last modified.

formatdate-time

snippet_name: str

Identify the snippet.

description: Optional[str]

Provide an informative description of the rule.

enabled: Optional[bool]

Indicate whether to execute the rule.

class RuleListResponse: …

Define a snippet rule.

id: str

Specify the unique ID of the rule.

expression: str

Define the expression that determines which traffic matches the rule.

minLength1

last_updated: datetime

Specify the timestamp of when the rule was last modified.

formatdate-time

snippet_name: str

Identify the snippet.

description: Optional[str]

Provide an informative description of the rule.

enabled: Optional[bool]

Indicate whether to execute the rule.

class RuleUpdateResponse: …

Define a snippet rule.

id: str

Specify the unique ID of the rule.

expression: str

Define the expression that determines which traffic matches the rule.

minLength1

last_updated: datetime

Specify the timestamp of when the rule was last modified.

formatdate-time

snippet_name: str

Identify the snippet.

description: Optional[str]

Provide an informative description of the rule.

enabled: Optional[bool]

Indicate whether to execute the rule.

class RuleDeleteResponse: …

Define a snippet rule.

id: str

Specify the unique ID of the rule.

expression: str

Define the expression that determines which traffic matches the rule.

minLength1

last_updated: datetime

Specify the timestamp of when the rule was last modified.

formatdate-time

snippet_name: str

Identify the snippet.

description: Optional[str]

Provide an informative description of the rule.

enabled: Optional[bool]

Indicate whether to execute the rule.