API reference: bridge
The Orbit command bridge, one end-to-end encrypted channel that every Orbit member shares. Transmissions are sealed under a bridge key that members pass to each other, wrapped to their sharing public keys, and the server stores and relays only ciphertext.
GET /v1/bridge/keys
Every wrap of the bridge key addressed to the caller. Needs a session.
The newcomer keeps the one that opens.
| Status | Description | Body |
|---|---|---|
| 200 | Wraps addressed to the caller. | BridgeKeyList application/json |
| 401 | No valid session token | Problem application/problem+json |
| 402 | Orbit required | Problem application/problem+json |
| 403 | Withdrawn from the bridge | Problem application/problem+json |
| 429 | Too many requests | Problem application/problem+json |
| 500 | The service failed | Problem application/problem+json |
| 503 | The service is at capacity | Problem application/problem+json |
POST /v1/bridge/keys
Seals the bridge key to one member, the first mint or an admission, by one who holds it. Needs a session.
Request body, application/json: BridgeSeal
| Status | Description | Body |
|---|---|---|
| 204 | Sealed, or already sealed by this member | |
| 400 | The request is malformed | Problem application/problem+json |
| 401 | No valid session token | Problem application/problem+json |
| 402 | Orbit required | Problem application/problem+json |
| 403 | Not the caller’s key to pass on, or withdrawn | Problem application/problem+json |
| 413 | The body is too large | Problem application/problem+json |
| 415 | The body is not JSON | Problem application/problem+json |
| 429 | Too many requests | Problem application/problem+json |
| 500 | The service failed | Problem application/problem+json |
| 503 | The service is at capacity | Problem application/problem+json |
POST /v1/bridge/keys:batchCreate
Seals one key the caller holds to every member in the batch, or to none of them. Needs a session.
Request body, application/json: BridgeSeals
| Status | Description | Body |
|---|---|---|
| 200 | Sealed, or already sealed by this member. | BridgeSealsResult application/json |
| 400 | The request is malformed | Problem application/problem+json |
| 401 | No valid session token | Problem application/problem+json |
| 402 | Orbit required | Problem application/problem+json |
| 403 | Not a key the caller holds, or withdrawn from the bridge | Problem application/problem+json |
| 413 | The body is too large | Problem application/problem+json |
| 415 | The body is not JSON | Problem application/problem+json |
| 429 | Too many requests | Problem application/problem+json |
| 500 | The service failed | Problem application/problem+json |
| 503 | The service is at capacity | Problem application/problem+json |
GET /v1/bridge/messages
Lists one page of the bridge, newest first: first load, history and gap repair alike. Needs a session.
| Name | In | Type | Description |
|---|---|---|---|
pageToken | query | string | A |
pageSize | query | integer (int64) | Transmissions per page. Absent takes the most a page holds. More is coerced to it. |
| Status | Description | Body |
|---|---|---|
| 200 | One page of transmissions. | BridgeHistory application/json |
| 400 | The request is malformed | Problem application/problem+json |
| 401 | No valid session token | Problem application/problem+json |
| 402 | Orbit required | Problem application/problem+json |
| 403 | Withdrawn from the bridge | Problem application/problem+json |
| 429 | Too many requests | Problem application/problem+json |
| 500 | The service failed | Problem application/problem+json |
| 503 | The service is at capacity | Problem application/problem+json |
POST /v1/bridge/messages
Creates one transmission and announces it to every live member. Needs a session.
Request body, application/json: BridgeSend
| Status | Description | Body |
|---|---|---|
| 201 | Stored and broadcast. | BridgeMessage application/json |
| 400 | The request is malformed | Problem application/problem+json |
| 401 | No valid session token | Problem application/problem+json |
| 402 | Orbit required | Problem application/problem+json |
| 403 | Withdrawn from the bridge | Problem application/problem+json |
| 413 | The body is too large | Problem application/problem+json |
| 415 | The body is not JSON | Problem application/problem+json |
| 429 | Inside the cadence | Problem application/problem+json |
| 500 | The service failed | Problem application/problem+json |
| 503 | The service is at capacity | Problem application/problem+json |
GET /v1/bridge/messages/{seq}
Reads one transmission by its place in the log. Needs a session.
| Name | In | Type | Description |
|---|---|---|---|
seq (required) | path | integer (int64) | The transmission’s sequence number. |
| Status | Description | Body |
|---|---|---|
| 200 | The transmission, still sealed. | BridgeMessage application/json |
| 400 | The request is malformed | Problem application/problem+json |
| 401 | No valid session token | Problem application/problem+json |
| 402 | Orbit required | Problem application/problem+json |
| 403 | Withdrawn from the bridge | Problem application/problem+json |
| 404 | No such transmission | Problem application/problem+json |
| 429 | Too many requests | Problem application/problem+json |
| 500 | The service failed | Problem application/problem+json |
| 503 | The service is at capacity | Problem application/problem+json |