subdomains

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

Overview

Name	subdomains
Type	Resource
Id	cloudflare.workers.subdomains

Fields

The following fields are returned by SELECT queries:

list

Get Subdomain response.

Name	Datatype	Description
subdomain	string	(example: my-subdomain)

Methods

The following methods are available for this resource:

Name	Accessible by	Required Params	Optional Params	Description
list	select	account_id		Returns a Workers subdomain for an account.
update	replace	account_id, subdomain		Creates a Workers subdomain for an account.
delete	delete	account_id		Deletes a Workers subdomain for an account.

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.

SELECT examples

list

Returns a Workers subdomain for an account.

SELECT
subdomain
FROM cloudflare.workers.subdomains
WHERE account_id = '{{ account_id }}' -- required
;

REPLACE examples

update

Creates a Workers subdomain for an account.

REPLACE cloudflare.workers.subdomains
SET 
subdomain = '{{ subdomain }}'
WHERE 
account_id = '{{ account_id }}' --required
AND subdomain = '{{ subdomain }}' --required
RETURNING
errors,
messages,
result,
success;

DELETE examples

delete

Deletes a Workers subdomain for an account.

DELETE FROM cloudflare.workers.subdomains
WHERE account_id = '{{ account_id }}' --required
;