导航|地址|刷新
Configure Snippets via API
图
Skip to contentDocumentation Index
Fetch the complete documentation index at: https://developers.cloudflare.com/rules/llms.txt
Use this file to discover all available pages before exploring further.



DocsDirectoryAPISDKsChangelog

Search

Log in






Rules

/




Overview

Examples


Configuration Rules


Overview

Create a rule in the dashboard

Create a rule via API

Available settings


Examples


Overview

Define a single configuration rule using Terraform










Snippets


Overview

How it works

Create in the dashboard

Configure via API

Configure using Terraform

Examples

Troubleshooting

When to use Snippets vs Workers






Transform Rules


Overview


Rewrite URLs


Overview

Create a rule in the dashboard

Create a rule via API

Create a rule using Terraform ↗


Reference


URL rewrite parameters

Available fields and functions










Modify request headers


Overview

Create a rule in the dashboard

Create a rule via API

Create a rule using Terraform ↗


Reference


Format of header names and values

Available fields and functions

API parameter reference










Modify response headers


Overview

Create a rule in the dashboard

Create a rule via API

Create a rule using Terraform ↗


Reference


Format of header names and values

Available fields and functions

API parameter reference










Managed Transforms


Overview

Configure Managed Transforms

Available Managed Transforms





Troubleshooting


Examples


Overview

Add a request header for subrequests from other zones

Add a request header with the current bot score

Add a response header with a static value

Add a wildcard CORS response header

Add request header with a static value

Normalize encoded slashes in URL path

Remove a request header

Remove a response header

Rewrite blog archive URLs

Rewrite image paths with several URL segments

Rewrite page path for visitors in specific countries

Rewrite path for object storage bucket

Rewrite path of archived blog posts

Rewrite path of moved section of a website

Rewrite URL query string

Set a response header with the current bot score

Set response header with a static value










Redirects


Overview


Single Redirects


Overview

Create rule in the dashboard

Create rule via API

Create rule using Terraform

Available settings






Bulk Redirects


Overview

Concepts

How it works

Create in the dashboard

Create via API

Configure using Terraform


Reference


URL redirect parameters

Supported URL components

Available fields and functions

CSV file format

API JSON objects





FAQ






Examples


Overview

Perform mobile redirects

Redirect admin area requests to HTTPS

Redirect from root to WWW

Redirect from WWW to root

Redirect local visitors to specific subdomains

Redirect requests for a domain to a new domain

Redirect requests from one country to a domain

Redirect requests from one domain to another

Redirect requests to a different hostname

Redirect visitors to a new page URL

Remove locale from URL path










Origin Rules


Overview

Create a rule in the dashboard

Create a rule via API


Examples


Overview

Change the destination port

Change the HTTP Host header and DNS record

Define a single origin rule using Terraform






Tutorials


Overview

Change URI path and Host header

Point to Pages with a custom domain

Point to R2 bucket with a custom domain





Available settings

API parameter reference

FAQ





Cache Rules ↗


Cloud ConnectorBeta


Overview

Configure a rule in the dashboard

Configure a rule via API

Configure rules using Terraform

Supported cloud providers


Examples


Overview

Route /images to an S3 Bucket

Route /images to an S3 Bucket using Terraform

Send EU visitors to a Google Cloud Storage bucket

Serve /static-assets from Azure Blob Storage










Custom Errors


Overview

Edit Error Pages

Create custom error rules

Example rules

Common API calls


Reference


Parameters

Error tokens

Error page types





Troubleshooting






Compression Rules


Overview

Create a rule in the dashboard

Create a rule via API

Available settings


Examples


Overview

Disable Brotli compression

Disable compression for AVIF images

Enable Zstandard compression for default content types

Use Gzip compression for CSV files

Use only Brotli compression for a specific path










Page Rules


Overview

Manage


How to


URL forwarding






Reference


Settings

Additional reference

Wildcard matching

Recommended rules






Troubleshooting


General

Billing and subscription










URL normalization


Overview

How it works

Configure in the dashboard

Settings

Examples






Trace a requestBeta


Overview

Use Cloudflare Trace

Limitations

Changelog






Reference


Rules language ↗

Troubleshooting

Page Rules migration guide





Changelog


Agent resources


Agent setup ↗

Cloudflare Skills ↗

Code Mode MCP Server ↗

Domain-specific MCP Servers ↗MCP

Rules llms.txt ↗

Rules llms-full.txt ↗

Cloudflare Docs llms.txt ↗

Cloudflare Docs llms-full.txt ↗













Home

/Rules

/Snippets

/Configure via API



Configure Snippets via API


Last updated Apr 16, 2026|Copy as Markdown|View as Markdown|Agent setup

OverviewRequired permissionsEndpointsExample API calls Create/update code snippet Create/update/delete snippet rules




You can create Snippets using the Cloudflare API.


Required permissions


The API token used in API requests to manage Snippets must have at least the following permission:

Zone > Snippets > Edit


Note


A token with this permission is only valid for the Snippets endpoints described in this page. You cannot use it to interact with the http_request_snippets phase via Rulesets API.




Endpoints


To obtain the complete endpoint, append the Snippets endpoints listed below to the Cloudflare API base URL:
https://api.cloudflare.com/client/v4
The {zone_id} argument is the zone ID (a hexadecimal string). You can find this value in the Cloudflare dashboard.

The following table summarizes the available operations.


OperationVerb + Endpoint
List all code snippetsGET /zones/{zone_id}/snippets
Create/update code snippetPUT /zones/{zone_id}/snippets/{snippet_name}
Get code snippet detailsGET /zones/{zone_id}/snippets/{snippet_name}
Get code snippet contentGET /zones/{zone_id}/snippets/{snippet_name}/content
Delete code snippetDELETE /zones/{zone_id}/snippets/{snippet_name}
List snippet rulesGET /zones/{zone_id}/snippets/snippet_rules
Create/update/delete snippet rulesPUT /zones/{zone_id}/snippets/snippet_rules
Delete all snippet rulesDELETE /zones/{zone_id}/snippets/snippet_rules




Example API calls



Create/update code snippet


To create or update a Snippet, use the following PUT request. The snippet is named $SNIPPET_NAME and the body contains the JavaScript code.

Required API token permissions
At least one of the following token permissions is required:
Snippets Write
Update a zone snippetbashcurl "https://api.cloudflare.com/client/v4/zones/$ZONE_ID/snippets/$SNIPPET_NAME" \ --request PUT \ --header "Authorization: Bearer $CLOUDFLARE_API_TOKEN" \ --form "files=@example.js" \ --form "metadata={\"main_module\": \"example.js\"}"
The name of a snippet can only contain the characters a-z, 0-9, and _ (underscore). The name must be unique in the context of the zone. You cannot change the snippet name after creating the snippet.

The required body parameters are:

files: The file with your JavaScript code.

metadata: Object containing main_module, which must match the filename of the uploaded file.

To make this example work, save your JavaScript code in a file named example.js, and then execute curl command with a PUT request from the folder where example.js is located.
Example responsejson{ "errors": [], "messages": [], "success": true, "result": { "created_on": "2023-07-24-00:00:00", "modified_on": "2023-07-24-00:00:00", "snippet_name": "snippet_name_01" }}
To deploy a new snippet you must create a snippet rule. The expression of the snippet rule defines when the snippet code will run.


Create/update/delete snippet rules



Caution


When using this endpoint to create a new rule and keep existing rules, you must include all rules in the request body. Omitting an existing rule will delete the corresponding rule.



Once you have created a code snippet, you can link it to rules. This is done via the following PUT request to the snippet_rules endpoint.

Required API token permissions
At least one of the following token permissions is required:
Snippets Write
Update zone snippet rulesbashcurl "https://api.cloudflare.com/client/v4/zones/$ZONE_ID/snippets/snippet_rules" \ --request PUT \ --header "Authorization: Bearer $CLOUDFLARE_API_TOKEN" \ --json '{ "rules": [ { "description": "Trigger snippet on specific cookie", "enabled": true, "expression": "http.cookie eq \"a=b\"", "snippet_name": "snippet_name_01" } ] }'

PreviousCreate in the dashboardNextConfigure using Terraform


Was this helpful?

YesNo

Edit pageReport issue




On this page

Overview

Required permissions

Endpoints

Example API calls

Create/update code snippet

Create/update/delete snippet rules


Edit pageReport issue














Getting started
PlansContact salesPartnersFind a partnerStartupsUnder attack?Domain name search


Company
AboutCareersInvestorsPressPress kitGlobal network




Public interest
Project GalileoAthenian ProjectCloudflare for CampaignsProject FairshotImpact/ESG


Compliance
Compliance resourcesTrust HubData ProtectionResponsible AITransparency reportReport abuse




Resources
App innovation reportCloudflare RadarCase studiesStatusSupportEventsBlog


Developers
DocumentationLearning centerCommunity




Solutions
SSE and SASE platformCloudflare AI CloudAI SecurityFrontend Development PlatformMulti-Tenant Platform DevelopmentWeb Security Platform


Start BuildingLog In












© 2026 Cloudflare, Inc.

Privacy policy|Report security issues|Terms of use|Trademark
|
Your privacy choices








Docs




------
导航页 打开网址