settings

Creates, updates, deletes, gets or lists a settings resource.

Overview

Name	settings
Type	Resource
Id	cloudflare.workers.settings

Fields

The following fields are returned by SELECT queries:

SELECT not supported for this resource, use SHOW METHODS to view available operations for the resource.

Methods

The following methods are available for this resource:

Name	Accessible by	Required Params	Optional Params	Description
worker_script_environment_patch_settings	update	account_id, service_name, environment_name, success, errors, messages, result		Patch script metadata, such as bindings.
edit	update	account_id, script_name		Patch script-level settings when using Worker Versions. Including but not limited to Logpush and Tail Consumers.

Parameters

Parameters can be passed in the WHERE clause of a query. Check the Methods section to see which parameters are required or optional for each operation.

Name	Datatype	Description
account_id	string	The Cloudflare account ID.
environment_name	string	The Worker service environment name.
script_name	string	The Worker script name.
service_name	string	The Worker service name.

UPDATE examples

worker_script_environment_patch_settings

Patch script metadata, such as bindings.

UPDATE cloudflare.workers.settings
SET 
errors = '{{ errors }}',
messages = '{{ messages }}',
success = {{ success }},
result = '{{ result }}'
WHERE 
account_id = '{{ account_id }}' --required
AND service_name = '{{ service_name }}' --required
AND environment_name = '{{ environment_name }}' --required
AND success = {{ success }} --required
AND errors = '{{ errors }}' --required
AND messages = '{{ messages }}' --required
AND result = '{{ result }}' --required
RETURNING
errors,
messages,
result,
success;

edit

Patch script-level settings when using Worker Versions. Including but not limited to Logpush and Tail Consumers.

UPDATE cloudflare.workers.settings
SET 
logpush = {{ logpush }},
observability = '{{ observability }}',
tags = '{{ tags }}',
tail_consumers = '{{ tail_consumers }}'
WHERE 
account_id = '{{ account_id }}' --required
AND script_name = '{{ script_name }}' --required
RETURNING
errors,
messages,
result,
success;