subdomain

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

Overview

Name	subdomain
Type	Resource
Id	cloudflare.workers.subdomain

Fields

The following fields are returned by SELECT queries:

list

Get subdomain response.

Name	Datatype	Description
enabled	boolean	Whether the Worker is available on the workers.dev subdomain.
previews_enabled	boolean	Whether the Worker's Preview URLs are available on the workers.dev subdomain. (x-stainless-terraform-configurability: computed_optional)

Methods

The following methods are available for this resource:

Name	Accessible by	Required Params	Optional Params	Description
list	select	account_id, script_name		Get if the Worker is available on the workers.dev subdomain.
create	insert	account_id, script_name, enabled		Enable or disable the Worker on the workers.dev subdomain.
delete	delete	account_id, script_name		Disable all workers.dev subdomains for a Worker.

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.
script_name	string	The Worker script name.

SELECT examples

list

Get if the Worker is available on the workers.dev subdomain.

SELECT
enabled,
previews_enabled
FROM cloudflare.workers.subdomain
WHERE account_id = '{{ account_id }}' -- required
AND script_name = '{{ script_name }}' -- required
;

INSERT examples

create

Enable or disable the Worker on the workers.dev subdomain.

INSERT INTO cloudflare.workers.subdomain (
enabled,
previews_enabled,
account_id,
script_name
)
SELECT 
{{ enabled }} /* required */,
{{ previews_enabled }},
'{{ account_id }}',
'{{ script_name }}'
RETURNING
errors,
messages,
result,
success
;

Manifest

# Description fields are for documentation purposes
- name: subdomain
props:
  - name: account_id
    value: "{{ account_id }}"
    description: Required parameter for the subdomain resource.
  - name: script_name
    value: "{{ script_name }}"
    description: Required parameter for the subdomain resource.
  - name: enabled
    value: {{ enabled }}
    description: |
      Whether the Worker should be available on the workers.dev subdomain.
  - name: previews_enabled
    value: {{ previews_enabled }}
    description: |
      Whether the Worker's Preview URLs should be available on the workers.dev subdomain.

DELETE examples

delete

Disable all workers.dev subdomains for a Worker.

DELETE FROM cloudflare.workers.subdomain
WHERE account_id = '{{ account_id }}' --required
AND script_name = '{{ script_name }}' --required
;