Skip to content
Cloudflare API
Start here
API Reference
MoQ

Relays

List relays
GET/accounts/{account_id}/moq/relays
Get a relay
GET/accounts/{account_id}/moq/relays/{relay_id}
Create a relay
POST/accounts/{account_id}/moq/relays
Update a relay
PUT/accounts/{account_id}/moq/relays/{relay_id}
Delete a relay
DELETE/accounts/{account_id}/moq/relays/{relay_id}
ModelsExpand Collapse
RelayListResponse object { created, modified, name, uid }

Abbreviated relay for list responses.

created: string
formatdate-time
modified: string
formatdate-time
name: string
uid: string
RelayGetResponse object { config, created, modified, 3 more }

Full relay details (no tokens).

config: object { lingering_subscribe, origin_fallback }

origin_fallback and lingering_subscribe are mutually exclusive.

lingering_subscribe: optional object { enabled, max_timeout_ms }
enabled: optional boolean
max_timeout_ms: optional number

Relay-level ceiling on lingering subscribe timeout (ms). Default 30000.

maximum300000
minimum0
origin_fallback: optional object { enabled, origins }
enabled: optional boolean
origins: optional array of object { url }

Ordered list of upstream origin relays. Each entry is an object (not a bare string) so per-origin configuration can be added in the future without another breaking change.

url: optional string

Upstream origin relay URL.

created: string
formatdate-time
modified: string
formatdate-time
name: string
uid: string
status: optional "connected"

“connected” when active, omitted otherwise.

RelayCreateResponse object { config, created, modified, 4 more }

Relay with auto-generated tokens (shown once).

config: object { lingering_subscribe, origin_fallback }

origin_fallback and lingering_subscribe are mutually exclusive.

lingering_subscribe: optional object { enabled, max_timeout_ms }
enabled: optional boolean
max_timeout_ms: optional number

Relay-level ceiling on lingering subscribe timeout (ms). Default 30000.

maximum300000
minimum0
origin_fallback: optional object { enabled, origins }
enabled: optional boolean
origins: optional array of object { url }

Ordered list of upstream origin relays. Each entry is an object (not a bare string) so per-origin configuration can be added in the future without another breaking change.

url: optional string

Upstream origin relay URL.

created: string
formatdate-time
modified: string
formatdate-time
name: string
token_publish_subscribe: string

Full access token (publish + subscribe). Treat as sensitive.

token_subscribe: string

Subscribe-only token. Treat as sensitive.

uid: string

Server-generated unique identifier (32 hex chars).

RelayUpdateResponse object { config, created, modified, 3 more }

Full relay details (no tokens).

config: object { lingering_subscribe, origin_fallback }

origin_fallback and lingering_subscribe are mutually exclusive.

lingering_subscribe: optional object { enabled, max_timeout_ms }
enabled: optional boolean
max_timeout_ms: optional number

Relay-level ceiling on lingering subscribe timeout (ms). Default 30000.

maximum300000
minimum0
origin_fallback: optional object { enabled, origins }
enabled: optional boolean
origins: optional array of object { url }

Ordered list of upstream origin relays. Each entry is an object (not a bare string) so per-origin configuration can be added in the future without another breaking change.

url: optional string

Upstream origin relay URL.

created: string
formatdate-time
modified: string
formatdate-time
name: string
uid: string
status: optional "connected"

“connected” when active, omitted otherwise.

RelayDeleteResponse = unknown

RelaysTokens

Rotate a token
POST/accounts/{account_id}/moq/relays/{relay_id}/tokens/rotate
ModelsExpand Collapse
TokenRotateResponse object { token, type }
token: string

New token value (shown once). Treat as sensitive.

type: "publish_subscribe" or "subscribe"
One of the following:
"publish_subscribe"
"subscribe"