Skip to content
Start here

Snippets

List zone snippets
GET/zones/{zone_id}/snippets
Get a zone snippet
GET/zones/{zone_id}/snippets/{snippet_name}
Update a zone snippet
PUT/zones/{zone_id}/snippets/{snippet_name}
Delete a zone snippet
DELETE/zones/{zone_id}/snippets/{snippet_name}
ModelsExpand Collapse
SnippetListResponse object { created_on, snippet_name, modified_on }

Define a snippet.

created_on: string

Indicates when the snippet was created.

formatdate-time
snippet_name: string

Identify the snippet.

modified_on: optional string

Indicates when the snippet was last modified.

formatdate-time
SnippetGetResponse object { created_on, snippet_name, modified_on }

Define a snippet.

created_on: string

Indicates when the snippet was created.

formatdate-time
snippet_name: string

Identify the snippet.

modified_on: optional string

Indicates when the snippet was last modified.

formatdate-time
SnippetUpdateResponse object { created_on, snippet_name, modified_on }

Define a snippet.

created_on: string

Indicates when the snippet was created.

formatdate-time
snippet_name: string

Identify the snippet.

modified_on: optional string

Indicates when the snippet was last modified.

formatdate-time
SnippetDeleteResponse = unknown

SnippetsContent

Get a zone snippet content
GET/zones/{zone_id}/snippets/{snippet_name}/content

SnippetsRules

List zone snippet rules
GET/zones/{zone_id}/snippets/snippet_rules
List zone snippet rules
GET/zones/{zone_id}/snippets/snippet_rules
Update zone snippet rules
PUT/zones/{zone_id}/snippets/snippet_rules
Delete zone snippet rules
DELETE/zones/{zone_id}/snippets/snippet_rules
ModelsExpand Collapse
RuleGetResponse object { 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: optional string

Provide an informative description of the rule.

enabled: optional boolean

Indicate whether to execute the rule.

RuleListResponse object { 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: optional string

Provide an informative description of the rule.

enabled: optional boolean

Indicate whether to execute the rule.

RuleUpdateResponse object { 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: optional string

Provide an informative description of the rule.

enabled: optional boolean

Indicate whether to execute the rule.

RuleDeleteResponse object { 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: optional string

Provide an informative description of the rule.

enabled: optional boolean

Indicate whether to execute the rule.