--- title: MoQ --- [Skip to content](#_top) [API Reference](https://developers.cloudflare.com/api/typescript) Copy Markdown Open in **Claude**Open in **ChatGPT**Open in **Cursor** --- **Copy Markdown****View as Markdown** # MoQ #### MoQRelays ##### [List relays](https://developers.cloudflare.com/api/typescript/resources/moq/subresources/relays/methods/list) client.moq.relays.list(RelayListParams {account\_id, asc, created\_after, 2 more } params, RequestOptionsoptions?): SinglePage< [RelayListResponse]() {created, modified, name, uid } > GET/accounts/{account\_id}/moq/relays ##### [Get a relay](https://developers.cloudflare.com/api/typescript/resources/moq/subresources/relays/methods/get) client.moq.relays.get(stringrelayID, RelayGetParams {account\_id } params, RequestOptionsoptions?): [RelayGetResponse]() {config, created, modified, 3 more } GET/accounts/{account\_id}/moq/relays/{relay\_id} ##### [Create a relay](https://developers.cloudflare.com/api/typescript/resources/moq/subresources/relays/methods/create) client.moq.relays.create(RelayCreateParams {account\_id, name } params, RequestOptionsoptions?): [RelayCreateResponse]() {config, created, issuers, 3 more } POST/accounts/{account\_id}/moq/relays ##### [Update a relay](https://developers.cloudflare.com/api/typescript/resources/moq/subresources/relays/methods/update) client.moq.relays.update(stringrelayID, RelayUpdateParams {account\_id, config, name } params, RequestOptionsoptions?): [RelayUpdateResponse]() {config, created, modified, 3 more } PUT/accounts/{account\_id}/moq/relays/{relay\_id} ##### [Delete a relay](https://developers.cloudflare.com/api/typescript/resources/moq/subresources/relays/methods/delete) client.moq.relays.delete(stringrelayID, RelayDeleteParams {account\_id } params, RequestOptionsoptions?): [RelayDeleteResponse]()| null DELETE/accounts/{account\_id}/moq/relays/{relay\_id} ##### ModelsExpand Collapse
RelayListResponse {created, modified, name, uid } Abbreviated relay for list responses. created: string formatdate-time Link to this property modified: string formatdate-time Link to this property name: string Link to this property uid: string Link to this property
[Link to this property](<#(resource)%20moq.relays%20%3E%20(model)%20relay_list_response%20%3E%20(schema)>)
RelayGetResponse {config, created, modified, 3 more } Full relay details (no tokens).
config: Config {upstreams }
upstreams?: Upstreams {enabled, upstreams } Upstreams are external MOQT server publishers that a relay falls back to when it has no local publisher for a requested namespace/track. enabled?: boolean Link to this property
upstreams?: Array<Upstream> Ordered list of upstream MOQT server publishers. Each entry is an object (not a bare string) so per-upstream configuration can be added in the future without another breaking change. url: string Upstream MOQT server publisher URL. Must be an absolute URL with a host and a scheme the relay can dial: moqt:// (raw QUIC) or https:// (WebTransport). Validated on update (PUT); rejected with 21013. formaturi Link to this property
Link to this property
Link to this property
Link to this property created: string formatdate-time Link to this property modified: string formatdate-time Link to this property name: string Link to this property uid: string Link to this property status?: "connected" “connected” when active, omitted otherwise. Link to this property
[Link to this property](<#(resource)%20moq.relays%20%3E%20(model)%20relay_get_response%20%3E%20(schema)>)
RelayCreateResponse {config, created, issuers, 3 more } Relay with its auto-created default token pair (one full-access \[publish, subscribe] and one \[subscribe]-only), each with its one-time secret, wrapped in the issuers envelope.
config: Config {upstreams }
upstreams?: Upstreams {enabled, upstreams } Upstreams are external MOQT server publishers that a relay falls back to when it has no local publisher for a requested namespace/track. enabled?: boolean Link to this property
upstreams?: Array<Upstream> Ordered list of upstream MOQT server publishers. Each entry is an object (not a bare string) so per-upstream configuration can be added in the future without another breaking change. url: string Upstream MOQT server publisher URL. Must be an absolute URL with a host and a scheme the relay can dial: moqt:// (raw QUIC) or https:// (WebTransport). Validated on update (PUT); rejected with 21013. formaturi Link to this property
Link to this property
Link to this property
Link to this property created: string formatdate-time Link to this property
issuers: Array<Issuer> Token collection (discriminated union on type). On create this holds the auto-created default pair, each including its one-time secret.
cloudflare\_tokens: Array<CloudflareToken> Always present (\[] when empty). created: string formatdate-time Link to this property expires: string Mandatory; no more than 1 year after created. formatdate-time Link to this property jti: string Token identity and registry key (32 hex chars). Link to this property
operations: Array<"publish"| "subscribe"> Signed allowlist of what the token may do. V1 coarse roles; the array form extends to fine-grained MoQT message names later without a breaking change. One of the following: "publish" Link to this property "subscribe" Link to this property
Link to this property label?: string Optional, customer-set. Link to this property secret?: string The signed JWT. Present ONLY in create / auto-create responses (shown once); never returned by list, never stored. Link to this property
Link to this property issuer: "cloudflare" Link to this property type: "cloudflare\_jwt" Link to this property
Link to this property modified: string formatdate-time Link to this property name: string Link to this property uid: string Server-generated unique identifier (32 hex chars). Link to this property
[Link to this property](<#(resource)%20moq.relays%20%3E%20(model)%20relay_create_response%20%3E%20(schema)>)
RelayUpdateResponse {config, created, modified, 3 more } Full relay details (no tokens).
config: Config {upstreams }
upstreams?: Upstreams {enabled, upstreams } Upstreams are external MOQT server publishers that a relay falls back to when it has no local publisher for a requested namespace/track. enabled?: boolean Link to this property
upstreams?: Array<Upstream> Ordered list of upstream MOQT server publishers. Each entry is an object (not a bare string) so per-upstream configuration can be added in the future without another breaking change. url: string Upstream MOQT server publisher URL. Must be an absolute URL with a host and a scheme the relay can dial: moqt:// (raw QUIC) or https:// (WebTransport). Validated on update (PUT); rejected with 21013. formaturi Link to this property
Link to this property
Link to this property
Link to this property created: string formatdate-time Link to this property modified: string formatdate-time Link to this property name: string Link to this property uid: string Link to this property status?: "connected" “connected” when active, omitted otherwise. Link to this property
[Link to this property](<#(resource)%20moq.relays%20%3E%20(model)%20relay_update_response%20%3E%20(schema)>) RelayDeleteResponse = unknown [Link to this property](<#(resource)%20moq.relays%20%3E%20(model)%20relay_delete_response%20%3E%20(schema)>) #### MoQRelaysTokens ##### [Create a token](https://developers.cloudflare.com/api/typescript/resources/moq/subresources/relays/subresources/tokens/methods/create) client.moq.relays.tokens.create(stringrelayID, TokenCreateParams {account\_id, operations, expires, label } params, RequestOptionsoptions?): [TokenCreateResponse]() {issuers } POST/accounts/{account\_id}/moq/relays/{relay\_id}/tokens ##### [List tokens](https://developers.cloudflare.com/api/typescript/resources/moq/subresources/relays/subresources/tokens/methods/list) client.moq.relays.tokens.list(stringrelayID, TokenListParams {account\_id } params, RequestOptionsoptions?): [TokenListResponse]() {issuers } GET/accounts/{account\_id}/moq/relays/{relay\_id}/tokens ##### [Revoke a token](https://developers.cloudflare.com/api/typescript/resources/moq/subresources/relays/subresources/tokens/methods/delete) client.moq.relays.tokens.delete(stringjti, TokenDeleteParams {account\_id, relay\_id } params, RequestOptionsoptions?): [TokenDeleteResponse]() {errors, messages, success } DELETE/accounts/{account\_id}/moq/relays/{relay\_id}/tokens/{jti} ##### ModelsExpand Collapse
TokenCreateResponse {issuers } A relay’s token collection, keyed on issuer type (a discriminated union). V1 ships exactly one arm (cloudflare_jwt). Clients iterate issuers, switch on type, and ignore unknown types — that contract is what makes adding or removing an arm non-breaking.
issuers: Array<Issuer>
cloudflare\_tokens: Array<CloudflareToken> Always present (\[] when empty). created: string formatdate-time Link to this property expires: string Mandatory; no more than 1 year after created. formatdate-time Link to this property jti: string Token identity and registry key (32 hex chars). Link to this property
operations: Array<"publish"| "subscribe"> Signed allowlist of what the token may do. V1 coarse roles; the array form extends to fine-grained MoQT message names later without a breaking change. One of the following: "publish" Link to this property "subscribe" Link to this property
Link to this property label?: string Optional, customer-set. Link to this property secret?: string The signed JWT. Present ONLY in create / auto-create responses (shown once); never returned by list, never stored. Link to this property
Link to this property issuer: "cloudflare" Link to this property type: "cloudflare\_jwt" Link to this property
Link to this property
[Link to this property](<#(resource)%20moq.relays.tokens%20%3E%20(model)%20token_create_response%20%3E%20(schema)>)
TokenListResponse {issuers } A relay’s token collection, keyed on issuer type (a discriminated union). V1 ships exactly one arm (cloudflare_jwt). Clients iterate issuers, switch on type, and ignore unknown types — that contract is what makes adding or removing an arm non-breaking.
issuers: Array<Issuer>
cloudflare\_tokens: Array<CloudflareToken> Always present (\[] when empty). created: string formatdate-time Link to this property expires: string Mandatory; no more than 1 year after created. formatdate-time Link to this property jti: string Token identity and registry key (32 hex chars). Link to this property
operations: Array<"publish"| "subscribe"> Signed allowlist of what the token may do. V1 coarse roles; the array form extends to fine-grained MoQT message names later without a breaking change. One of the following: "publish" Link to this property "subscribe" Link to this property
Link to this property label?: string Optional, customer-set. Link to this property secret?: string The signed JWT. Present ONLY in create / auto-create responses (shown once); never returned by list, never stored. Link to this property
Link to this property issuer: "cloudflare" Link to this property type: "cloudflare\_jwt" Link to this property
Link to this property
[Link to this property](<#(resource)%20moq.relays.tokens%20%3E%20(model)%20token_list_response%20%3E%20(schema)>)
TokenDeleteResponse {errors, messages, success }
errors: Array<Error> code?: number Link to this property message?: string Link to this property
Link to this property
messages: Array<Message> code?: number Link to this property message?: string Link to this property
Link to this property success: boolean Link to this property
[Link to this property](<#(resource)%20moq.relays.tokens%20%3E%20(model)%20token_delete_response%20%3E%20(schema)>)