Information
- OpenAPI version:
3.1.0
Switchboard Relay API 1
Section titled “Switchboard Relay API 1”The endpoints a moq-relay calls. The only one you call yourself is
POST /cluster/enroll, once, when you set up a Self-hosted relay. The
rest are documented so you can see what your relay is doing and make
sense of its errors.
A relay proves who it is with a credential in the URL, as jwt=. A
Self-hosted relay uses its Node key (sbn_...). A request without one is
a 401.
These endpoints work with stock moqdev/moq-relay 0.15 or later. The
request and response shapes of /cluster/connect and /auth are
moq-relay’s, not ours.
Authentication
Section titled “Authentication”nodeKey
Section titled “nodeKey”The Node key (sbn_...) from POST /cluster/enroll.
Security scheme type: apiKey
Query parameter name: jwt