Cloudflare API | Zaraz › Update Zaraz Workflow

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

URL Normalization

Security

Content Scanning

Leaked Credential Checks

Storage & Databases

Threat Intelligence

Brand Protection

Workers & Pages

Browser Rendering

Durable Objects

Workers For Platforms

Shared

Update Zaraz workflow

Zaraz

zaraz

Methods

Update Zaraz Workflow -> Envelope<

>

put/zones/{zone_id}/settings/zaraz/workflow

Updates Zaraz workflow for a 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)

Zaraz Edit Zaraz Admin

path Parameters

zone_id: string

(maxLength: 32)

Identifier

Response fields

errors: Array<

>

messages: Array<

>

result:

Zaraz workflow

success: boolean

Whether the API call was successful

Request example

curl https://api.cloudflare.com/client/v4/zones/$ZONE_ID/settings/zaraz/workflow \
    -X PUT \
    -H 'Content-Type: application/json' \
    -H "X-Auth-Email: $CLOUDFLARE_EMAIL" \
    -H "X-Auth-Key: $CLOUDFLARE_API_KEY" \
    -d '"realtime"'

200Example

{
  "errors": [
    {
      "code": 1000,
      "message": "message",
      "documentation_url": "documentation_url",
      "source": {
        "pointer": "pointer"
      }
    }
  ],
  "messages": [
    {
      "code": 1000,
      "message": "message",
      "documentation_url": "documentation_url",
      "source": {
        "pointer": "pointer"
      }
    }
  ],
  "result": "realtime",
  "success": true
}

Domain types

ButtonTextTranslation = { accept_all, confirm_my_choices, reject_all }

NeoEvent = { actionType, blockingTriggers, data, 1 more... }

Config

zaraz.config

Methods

Get Zaraz Configuration -> Envelope<

>

get/zones/{zone_id}/settings/zaraz/config

Gets latest Zaraz configuration for a zone. It can be preview or published configuration, whichever was the last updated. Secret variables values will not be included.

Update Zaraz Configuration -> Envelope<

>

put/zones/{zone_id}/settings/zaraz/config

Updates Zaraz configuration for a zone.

Domain types

Configuration = { dataLayer, debugKey, settings, 7 more... }

Zaraz configuration

Default

zaraz.default

Methods

Get Default Zaraz Configuration -> Envelope<

>

get/zones/{zone_id}/settings/zaraz/default

Gets default Zaraz configuration for a zone.

Export

zaraz.export

Methods

Export Zaraz Configuration ->

get/zones/{zone_id}/settings/zaraz/export

Exports full current published Zaraz configuration for a zone, secret variables included.

History

zaraz.history

Methods

List Zaraz Historical Configuration Records -> SinglePage<{ id, createdAt, description, 2 more... }>

get/zones/{zone_id}/settings/zaraz/history

Lists a history of published Zaraz configuration records for a zone.

Restore Zaraz Historical Configuration By ID -> Envelope<

>

put/zones/{zone_id}/settings/zaraz/history

Restores a historical published Zaraz configuration by ID for a zone.

Configs

zaraz.history.configs

Methods

Get Zaraz Historical Configurations By ID S -> Envelope<Record<string, { id, config, createdAt, 2 more... }>>

get/zones/{zone_id}/settings/zaraz/history/configs

Gets a history of published Zaraz configurations by ID(s) for a zone.

Publish

zaraz.publish

Methods

Publish Zaraz Preview Configuration -> Envelope<string>

post/zones/{zone_id}/settings/zaraz/publish

Publish current Zaraz preview configuration for a zone.

Workflow

zaraz.workflow

Methods

Get Zaraz Workflow -> Envelope<

>

get/zones/{zone_id}/settings/zaraz/workflow

Gets Zaraz workflow for a zone.

Domain types

Workflow = "realtime" | "preview"

Zaraz workflow