Snippets

snippets

Methods

Delete Snippet -> { errors, messages, success }
delete/zones/{zone_id}/snippets/{snippet_name}

Delete Snippet

Security
API Email + API Key

The previous authorization scheme for interacting with the Cloudflare API, used in conjunction with a Global API key.

Example: X-Auth-Email: user@example.com

The previous authorization scheme for interacting with the Cloudflare API. When possible, use API tokens instead of Global API keys.

Example: X-Auth-Key: 144c9defac04969c7bfad8efaa8ea194

Accepted Permissions (at least one required)

Snippets Write

Parameters
zone_id: string
(maxLength: 32)

Identifier

snippet_name: string

Snippet identifying name

Response fields
errors: Array<>
messages: Array<>
success: true

Whether the API call was successful

Request example
200Example
Snippet -> Envelope<>
get/zones/{zone_id}/snippets/{snippet_name}

Snippet

All Snippets -> SinglePage<>
get/zones/{zone_id}/snippets

All Snippets

Put Snippet -> Envelope<>
put/zones/{zone_id}/snippets/{snippet_name}

Put Snippet

Domain types

Snippet = { created_on, modified_on, snippet_name }

Snippet Information

Snippets

Content

snippets.content

Methods

Snippet Content -> unknown
get/zones/{zone_id}/snippets/{snippet_name}/content

Snippet Content

snippets.rules

Methods

Delete All Rules -> { errors, messages, success }
delete/zones/{zone_id}/snippets/snippet_rules

Delete All Rules

Rules -> SinglePage<{ description, enabled, expression, 1 more... }>
get/zones/{zone_id}/snippets/snippet_rules

Rules

Put Rules -> SinglePage<{ description, enabled, expression, 1 more... }>
put/zones/{zone_id}/snippets/snippet_rules

Put Rules