relays

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

Overview

Name	relays
Type	Resource
Id	cloudflare.realtime_kit.relays

Fields

The following fields are returned by SELECT queries:

get

Relay retrieved successfully.

Name	Datatype	Description
name	string	(example: Production Live Stream)
config	object	origin_fallback and lingering_subscribe are mutually exclusive.
created	string (date-time)
modified	string (date-time)
status	string	"connected" when active, omitted otherwise. (connected)
uid	string	(example: a1b2c3d4e5f67890a1b2c3d4e5f67890)

list

Relay list retrieved successfully.

Name	Datatype	Description
name	string
created	string (date-time)
modified	string (date-time)
uid	string	(example: a1b2c3d4e5f67890a1b2c3d4e5f67890)

Methods

The following methods are available for this resource:

Name	Accessible by	Required Params	Optional Params	Description
get	select	account_id, relay_id		Retrieves a single MoQ relay including config and status. Tokens are NOT included.
list	select	account_id		Lists all MoQ relays for the account. Returns only metadata. Config, status, and tokens are omitted.
post_accounts_account_id_moq_relays	insert	account_id, name		Provisions a new MoQ relay instance. Auto-creates a publish+subscribe token and a subscribe-only token. Token values are included in the response (shown once). Config is set to defaults (lingering subscribe enabled, 30s ceiling, origin fallback off). Use PUT to modify.
put_accounts_account_id_moq_relays_relay_id	replace	account_id, relay_id		Updates a relay's name and/or configuration. Partial updates: omitted fields are preserved. Config sub-objects replace as whole objects when present. origin_fallback and lingering_subscribe are mutually exclusive.
delete_accounts_account_id_moq_relays_relay_id	delete	account_id, relay_id		Soft-deletes a MoQ relay.
rotate	exec	account_id, relay_id, type		Generates a new token for the specified type. The old token is immediately invalidated. Token value is shown once in the response.

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.
relay_id	string	Relay unique identifier (32 hex characters).

SELECT examples

get

Retrieves a single MoQ relay including config and status. Tokens are NOT included.

SELECT
name,
config,
created,
modified,
status,
uid
FROM cloudflare.realtime_kit.relays
WHERE account_id = '{{ account_id }}' -- required
AND relay_id = '{{ relay_id }}' -- required
;

list

Lists all MoQ relays for the account. Returns only metadata. Config, status, and tokens are omitted.

SELECT
name,
created,
modified,
uid
FROM cloudflare.realtime_kit.relays
WHERE account_id = '{{ account_id }}' -- required
;

INSERT examples

post_accounts_account_id_moq_relays

Provisions a new MoQ relay instance. Auto-creates a publish+subscribe token and a subscribe-only token. Token values are included in the response (shown once). Config is set to defaults (lingering subscribe enabled, 30s ceiling, origin fallback off). Use PUT to modify.

INSERT INTO cloudflare.realtime_kit.relays (
name,
account_id
)
SELECT 
'{{ name }}' /* required */,
'{{ account_id }}'
RETURNING
errors,
messages,
result,
success
;

Manifest

# Description fields are for documentation purposes
- name: relays
props:
  - name: account_id
    value: "{{ account_id }}"
    description: Required parameter for the relays resource.
  - name: name
    value: "{{ name }}"
    description: |
      Human-readable name for the relay.

REPLACE examples

put_accounts_account_id_moq_relays_relay_id

Updates a relay's name and/or configuration. Partial updates: omitted fields are preserved. Config sub-objects replace as whole objects when present. origin_fallback and lingering_subscribe are mutually exclusive.

REPLACE cloudflare.realtime_kit.relays
SET 
config = '{{ config }}',
name = '{{ name }}'
WHERE 
account_id = '{{ account_id }}' --required
AND relay_id = '{{ relay_id }}' --required
RETURNING
errors,
messages,
result,
success;

DELETE examples

delete_accounts_account_id_moq_relays_relay_id

Soft-deletes a MoQ relay.

DELETE FROM cloudflare.realtime_kit.relays
WHERE account_id = '{{ account_id }}' --required
AND relay_id = '{{ relay_id }}' --required
;

Lifecycle Methods

rotate

Generates a new token for the specified type. The old token is immediately invalidated. Token value is shown once in the response.

EXEC cloudflare.realtime_kit.relays.rotate 
@account_id='{{ account_id }}' --required, 
@relay_id='{{ relay_id }}' --required 
@@json=
'{
"type": "{{ type }}"
}'
;