Skip to content
Cloudflare API
Start here
API Reference

MoQ

MoQRelays

List relays
moq.relays.list(RelayListParams**kwargs) -> SyncSinglePage[RelayListResponse]
GET/accounts/{account_id}/moq/relays
Get a relay
moq.relays.get(strrelay_id, RelayGetParams**kwargs) -> RelayGetResponse
GET/accounts/{account_id}/moq/relays/{relay_id}
Create a relay
moq.relays.create(RelayCreateParams**kwargs) -> RelayCreateResponse
POST/accounts/{account_id}/moq/relays
Update a relay
moq.relays.update(strrelay_id, RelayUpdateParams**kwargs) -> RelayUpdateResponse
PUT/accounts/{account_id}/moq/relays/{relay_id}
Delete a relay
moq.relays.delete(strrelay_id, RelayDeleteParams**kwargs) -> object
DELETE/accounts/{account_id}/moq/relays/{relay_id}
ModelsExpand Collapse
class RelayListResponse: …

Abbreviated relay for list responses.

created: datetime
formatdate-time
modified: datetime
formatdate-time
name: str
uid: str
class RelayGetResponse: …

Full relay details (no tokens).

config: Config

origin_fallback and lingering_subscribe are mutually exclusive.

lingering_subscribe: Optional[ConfigLingeringSubscribe]
enabled: Optional[bool]
max_timeout_ms: Optional[int]

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

maximum300000
minimum0
origin_fallback: Optional[ConfigOriginFallback]
enabled: Optional[bool]
origins: Optional[List[ConfigOriginFallbackOrigin]]

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[str]

Upstream origin relay URL.

created: datetime
formatdate-time
modified: datetime
formatdate-time
name: str
uid: str
status: Optional[Literal["connected"]]

“connected” when active, omitted otherwise.

class RelayCreateResponse: …

Relay with auto-generated tokens (shown once).

config: Config

origin_fallback and lingering_subscribe are mutually exclusive.

lingering_subscribe: Optional[ConfigLingeringSubscribe]
enabled: Optional[bool]
max_timeout_ms: Optional[int]

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

maximum300000
minimum0
origin_fallback: Optional[ConfigOriginFallback]
enabled: Optional[bool]
origins: Optional[List[ConfigOriginFallbackOrigin]]

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[str]

Upstream origin relay URL.

created: datetime
formatdate-time
modified: datetime
formatdate-time
name: str
token_publish_subscribe: str

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

token_subscribe: str

Subscribe-only token. Treat as sensitive.

uid: str

Server-generated unique identifier (32 hex chars).

class RelayUpdateResponse: …

Full relay details (no tokens).

config: Config

origin_fallback and lingering_subscribe are mutually exclusive.

lingering_subscribe: Optional[ConfigLingeringSubscribe]
enabled: Optional[bool]
max_timeout_ms: Optional[int]

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

maximum300000
minimum0
origin_fallback: Optional[ConfigOriginFallback]
enabled: Optional[bool]
origins: Optional[List[ConfigOriginFallbackOrigin]]

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[str]

Upstream origin relay URL.

created: datetime
formatdate-time
modified: datetime
formatdate-time
name: str
uid: str
status: Optional[Literal["connected"]]

“connected” when active, omitted otherwise.

MoQRelaysTokens

Rotate a token
moq.relays.tokens.rotate(strrelay_id, TokenRotateParams**kwargs) -> TokenRotateResponse
POST/accounts/{account_id}/moq/relays/{relay_id}/tokens/rotate
ModelsExpand Collapse
class TokenRotateResponse: …
token: str

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

type: Literal["publish_subscribe", "subscribe"]
One of the following:
"publish_subscribe"
"subscribe"