Cloudflare API | Snippets › list

API Reference

Account & User Management

Resource Sharing

AI

Certificate Management

Certificate Authorities

Client Certificates

Custom Certificates

Custom Hostnames

Keyless Certificates

MTLS Certificates

Origin CA Certificates

Origin Post Quantum Encryption

Origin TLS Client Auth

Cloudflare One

DNS

Account Custom Nameservers

Domain/Zone Management

IP Addresses

Media

Networking

Magic Cloud Networking

Magic Network Monitoring

Network Interconnects

Observability

Security Center

Radar

Routing & Performance

Rules

Cloud Connector

Managed Transforms

List zone snippets

Get a zone snippet

Update a zone snippet

Delete a zone snippet

URL Normalization

Security

Schema Validation

Content Scanning

Leaked Credential Checks

Token Validation

Storage & Databases

R2 Data Catalog

Threat Intelligence

Brand Protection

Workers & Pages

Browser Rendering

Durable Objects

Workers For Platforms

Shared

Snippets

Snippets

Methods

client.snippets.list(, ):

V4PagePaginationArray

<

SnippetListResponse

>

get/zones/{zone_id}/snippets

Fetches all snippets belonging to the zone.

Security

The preferred authorization scheme for interacting with the Cloudflare API. Create a token.

Example: Authorization: Bearer Sn3lZJTBX6kkg7OdcBUAxOO963GEIyGQqnFTOFYY

Accepted Permissions (at least one required)

Snippets Write Snippets Read

Parameters

params:

SnippetListParams

zone_id: string

Path param: The unique ID of the zone.

page?: number

(minimum: 1)

Query param: The current page number.

per_page?: number

(minimum: 1)

Query param: The number of results to return per page.

Returns

SnippetListResponse{

A snippet object.

created_on: string

(format: date-time)

The timestamp of when the snippet was created.

snippet_name: string

The identifying name of the snippet.

modified_on?: string

(format: date-time)

The timestamp of when the snippet was last modified.

Request example

import Cloudflare from 'cloudflare';

const client = new Cloudflare({
  apiToken: process.env['CLOUDFLARE_API_TOKEN'], // This is the default and can be omitted
});

// Automatically fetches more pages as needed.
for await (const snippetListResponse of client.snippets.list({
  zone_id: '9f1839b6152d298aca64c4e906b6d074',
})) {
  console.log(snippetListResponse.created_on);
}

200Example

{
  "errors": [
    {
      "message": "something bad happened",
      "code": 10000
    }
  ],
  "messages": [
    {
      "message": "something bad happened",
      "code": 10000
    }
  ],
  "result": [
    {
      "created_on": "2000-01-01T00:00:00.000000Z",
      "snippet_name": "my_snippet",
      "modified_on": "2000-01-01T00:00:00.000000Z"
    }
  ],
  "success": true,
  "result_info": {
    "count": 25,
    "page": 1,
    "per_page": 25,
    "total_count": 100,
    "total_pages": 10
  }
}

client.snippets.get(, , ):

SnippetGetResponse

get/zones/{zone_id}/snippets/{snippet_name}

Fetches a snippet belonging to the zone.

client.snippets.update(, , ):

SnippetUpdateResponse

put/zones/{zone_id}/snippets/{snippet_name}

Creates or updates a snippet belonging to the zone.

client.snippets.delete(, , ):

SnippetDeleteResponse

| null

delete/zones/{zone_id}/snippets/{snippet_name}

Deletes a snippet belonging to the zone.

Content

Snippets.Content

Methods

client.snippets.content.get(, , ):

get/zones/{zone_id}/snippets/{snippet_name}/content

Fetches the content of a snippet belonging to the zone.

Rules

Snippets.Rules

Methods

client.snippets.rules.list(, ):

<

RuleListResponse

>

get/zones/{zone_id}/snippets/snippet_rules

Fetches all snippet rules belonging to the zone.

client.snippets.rules.update(, ):

<

RuleUpdateResponse

>

put/zones/{zone_id}/snippets/snippet_rules

Updates all snippet rules belonging to the zone.

client.snippets.rules.delete(, ):

<

RuleDeleteResponse

>

delete/zones/{zone_id}/snippets/snippet_rules

Deletes all snippet rules belonging to the zone.