Skip to main content
GET
List relays

Authorizations

__Host-oc_session
string
cookie
required

Query Parameters

cursor
string

Opaque resume position returned in the preceding page's next field.

Required string length: 1 - 512
limit
integer
default:50
Required range: 1 <= x <= 200

Case-insensitive containment search over the Relay identifier, fingerprint, and version.

Required string length: 1 - 256
sort
enum<string>
Available options:
registeredAt,
-registeredAt,
lastSeenAt,
-lastSeenAt,
version,
-version,
fingerprint,
-fingerprint
state
enum<string>
Available options:
connected,
disconnected,
revoked,
degraded
version
string

Exact Relay version without surrounding whitespace.

Required string length: 1 - 128
Pattern: ^\S(?:.*\S)?$
capability
string

Exact capability identifier without surrounding whitespace.

Required string length: 1 - 128
Pattern: ^\S(?:.*\S)?$

Response

Relay roster.

next
string | null
required
Maximum string length: 512
total
integer | null
required
Required range: x >= 0
items
object[]
required