[ Web Proxy ]
URL:
Viewing: https://developers.cloudflare.com/api/resources/snippets/methods/update [Back]  [Original]
Update a zone snippet | Cloudflare API Skip to content
logo.DMYpXs3t.svg [logo.DMYpXs3t.svg] Cloudflare API
CtrlK
Start here
Start here
HTTP
API Reference
Snippets
Copy Markdown

Update a zone snippet

PUT/zones/{zone_id}/snippets/{snippet_name}

Creates or updates a snippet belonging to the zone.

Security
API Token

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

Example:Authorization: Bearer Sn3lZJTBX6kkg7OdcBUAxOO963GEIyGQqnFTOFYY
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
Path ParametersExpand Collapse
zone_id: string

Use this field to specify the unique ID of the zone.

snippet_name: string

Identify the snippet.

Body ParametersForm DataExpand Collapse
metadata: object { main_module }

Provide metadata about the snippet.

main_module: string

Specify the name of the file that contains the main module of the snippet.

minLength1
ReturnsExpand Collapse
errors: array of object { message, code }

Lists error messages.

message: string

Describes the message text.

minLength1
code: optional number

Identify the message code.

messages: array of object { message, code }

Contain warning messages.

message: string

Describes the message text.

minLength1
code: optional number

Identify the message code.

result: object { created_on, snippet_name, modified_on }

Contain the response result.

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
success: true

Indicate whether the API call was successful.

Update a zone snippet

HTTP
curl https://api.cloudflare.com/client/v4/zones/$ZONE_ID/snippets/$SNIPPET_NAME \
    -X PUT \
    -H 'Content-Type: multipart/form-data' \
    -H "Authorization: Bearer $CLOUDFLARE_API_TOKEN" \
    -F metadata='{"main_module":"main.js"}'
200 example
{
  "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
}
Returns Examples
200 example
{
  "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
}
Web Proxy Viewer  |  New URL  |  Original Page