secrets

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

Overview

Name	secrets
Type	Resource
Id	cloudflare.workers_for_platforms.secrets

Fields

The following fields are returned by SELECT queries:

get

Get script secret (Workers for Platforms).

Name	Datatype	Description
name	string	A JavaScript variable name for the binding. (example: myBinding)
algorithm	object	Algorithm-specific key parameters. Learn more.
format	string	Data format of the key. Learn more. (raw, pkcs8, spki, jwk) (example: raw)
key_base64	string	Base64-encoded key data. Required if format is "raw", "pkcs8", or "spki".
key_jwk	object	Key data in JSON Web Key format. Required if format is "jwk".
text	string	The secret value to use. (example: My secret.)
type	string	The kind of resource that the binding provides. (secret_text)
usages	array	Allowed operations with the key. Learn more. (x-stainless-collection-type: set)

list

List script secrets.

Name	Datatype	Description
name	string	A JavaScript variable name for the binding. (example: myBinding)
algorithm	object	Algorithm-specific key parameters. Learn more.
format	string	Data format of the key. Learn more. (raw, pkcs8, spki, jwk) (example: raw)
key_base64	string	Base64-encoded key data. Required if format is "raw", "pkcs8", or "spki".
key_jwk	object	Key data in JSON Web Key format. Required if format is "jwk".
text	string	The secret value to use. (example: My secret.)
type	string	The kind of resource that the binding provides. (secret_text)
usages	array	Allowed operations with the key. Learn more. (x-stainless-collection-type: set)

Methods

The following methods are available for this resource:

Name	Accessible by	Required Params	Optional Params	Description
get	select	account_id, dispatch_namespace, script_name, secret_name	url_encoded	Get a given secret binding (value omitted) on a script uploaded to a Workers for Platforms namespace.
list	select	account_id, dispatch_namespace, script_name		List secrets bound to a script uploaded to a Workers for Platforms namespace.
update	replace	account_id, dispatch_namespace, script_name, name, type		Add a secret to a script uploaded to a Workers for Platforms namespace.
delete	delete	account_id, dispatch_namespace, script_name, secret_name	url_encoded	Remove a secret from a script uploaded to a Workers for Platforms namespace.

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.
dispatch_namespace	string	The Workers-for-Platforms dispatch namespace.
script_name	string	The Worker script name.
secret_name	string
url_encoded	boolean

SELECT examples

get

Get a given secret binding (value omitted) on a script uploaded to a Workers for Platforms namespace.

SELECT
name,
algorithm,
format,
key_base64,
key_jwk,
text,
type,
usages
FROM cloudflare.workers_for_platforms.secrets
WHERE account_id = '{{ account_id }}' -- required
AND dispatch_namespace = '{{ dispatch_namespace }}' -- required
AND script_name = '{{ script_name }}' -- required
AND secret_name = '{{ secret_name }}' -- required
AND url_encoded = '{{ url_encoded }}'
;

list

List secrets bound to a script uploaded to a Workers for Platforms namespace.

SELECT
name,
algorithm,
format,
key_base64,
key_jwk,
text,
type,
usages
FROM cloudflare.workers_for_platforms.secrets
WHERE account_id = '{{ account_id }}' -- required
AND dispatch_namespace = '{{ dispatch_namespace }}' -- required
AND script_name = '{{ script_name }}' -- required
;

REPLACE examples

update

Add a secret to a script uploaded to a Workers for Platforms namespace.

REPLACE cloudflare.workers_for_platforms.secrets
SET 
name = '{{ name }}',
text = '{{ text }}',
type = '{{ type }}',
algorithm = '{{ algorithm }}',
format = '{{ format }}',
key_base64 = '{{ key_base64 }}',
key_jwk = '{{ key_jwk }}',
usages = '{{ usages }}'
WHERE 
account_id = '{{ account_id }}' --required
AND dispatch_namespace = '{{ dispatch_namespace }}' --required
AND script_name = '{{ script_name }}' --required
AND name = '{{ name }}' --required
AND type = '{{ type }}' --required
RETURNING
errors,
messages,
result,
success;

DELETE examples

delete

Remove a secret from a script uploaded to a Workers for Platforms namespace.

DELETE FROM cloudflare.workers_for_platforms.secrets
WHERE account_id = '{{ account_id }}' --required
AND dispatch_namespace = '{{ dispatch_namespace }}' --required
AND script_name = '{{ script_name }}' --required
AND secret_name = '{{ secret_name }}' --required
AND url_encoded = '{{ url_encoded }}'
;