Skip to main content
GET
Find relays for a broadcast path

Query Parameters

path
string
required

The broadcast path the client will publish or watch, as its credential names it: <organization slug>/<project slug>/..., at least two segments of lower-case letters, digits, - and _. Surrounding and doubled slashes are ignored.

Maximum string length: 1024
region
string

A region (or provider zone) to put first, e.g. tyo, when the client knows where it is better than its address does.

Pattern: ^[a-z0-9][a-z0-9-]{0,62}$

Response

Where to connect.

relays
object[]
required

Where to connect, best first. Empty when no relay is available.

fallback
string[]
required

host:port addresses to try in order if the relays above fail, ending with the public relay name.

Example: