These endpoints are read-only. They tell you what really happened in
your project: which connections succeeded, which failed, and why. If Livqeno
doesn't know a value, you get null or nothing, never a guess.
- Call them from your backend or a monitoring job, with your project API key (the same one the server SDKs use).
- The dashboard shows the same data. Use these for your own monitoring tools, for example a job that alerts you when failed connections go up.
How to use them during an incident: Observability.
Endpoints
| Method | Path | Credential |
|---|---|---|
| GET | /v1/connections | Project API key |
| GET | /v1/connections/{connectionId} | Project API key |
| GET | /v1/diagnostics | Project API key |
| GET | /v1/errors | Project API key |
| GET | /v1/errors/{errorId} | Project API key |
| GET | /v1/metrics | Project API key |
| GET | /v1/project | Project API key |
| DELETE | /v1/recording-storage | Project API key |
| GET | /v1/recording-storage | Project API key |
| PUT | /v1/recording-storage | Project API key |
| GET | /v1/recordings/{recordingId} | Project API key |
| POST | /v1/recordings/{recordingId}/stop | Project API key |
GET/v1/connections
List the API key's project's real RTC connections
Credential Project API key
| Parameter | In | Type | Required | Notes |
|---|---|---|---|---|
state | query | ConnectionState | No | CONNECTING · CONNECTED · RECONNECTING · DISCONNECTED · FAILED |
roomId | query | string | No | |
limit | query | number | No | 1–200 |
cursor | query | string | No | The previous page's last connection publicId. Omit for the first page. |
GET/v1/connections/{connectionId}
Get one connection with its full event timeline and any errors
Credential Project API key
| Parameter | In | Type | Required | Notes |
|---|---|---|---|---|
connectionId | path | string | Yes |
GET/v1/diagnostics
Authenticated per-dependency diagnostics for the API key's project
Credential Project API key
No parameters.
GET/v1/errors
List the API key's project's classified errors
Credential Project API key
| Parameter | In | Type | Required | Notes |
|---|---|---|---|---|
category | query | ErrorCategory | No | AUTHENTICATION_ERROR · AUTHORIZATION_ERROR · TOKEN_ERROR · SIGNALING_ERROR · ICE_ERROR · TURN_ERROR · SFU_ERROR · NETWORK_ERROR · CLIENT_ERROR · UNKNOWN_ERROR |
connectionId | query | string | No | |
limit | query | number | No | 1–200 |
GET/v1/errors/{errorId}
Get one classified error, with its connection if any
Credential Project API key
| Parameter | In | Type | Required | Notes |
|---|---|---|---|---|
errorId | path | string | Yes |
GET/v1/metrics
Real aggregate connection/error metrics for the API key's project
Credential Project API key
No parameters.
GET/v1/project
Get the API key's own project
Credential Project API key
No parameters.
DELETE/v1/recording-storage
Credential Project API key
No parameters.
GET/v1/recording-storage
The project's own recording bucket (secret redacted)
Credential Project API key
No parameters.
PUT/v1/recording-storage
Use your own S3-compatible bucket for recordings (checked with a test write)
Credential Project API key
| Parameter | In | Type | Required | Notes |
|---|---|---|---|---|
endpoint | body | string | Yes | 0–512 chars |
region | body | string | No | 0–64 chars |
bucket | body | string | Yes | 3–63 chars |
prefix | body | string | No | 0–256 chars, pattern-checked |
accessKeyId | body | string | Yes | 1–256 chars |
secretAccessKey | body | string | Yes | 1–512 chars |
forcePathStyle | body | boolean | No | |
publicBaseUrl | body | string | No | 0–512 chars — Public/CDN base URL for file links; defaults to the endpoint followed by the bucket name. |
GET/v1/recordings/{recordingId}
Credential Project API key
| Parameter | In | Type | Required | Notes |
|---|---|---|---|---|
recordingId | path | string | Yes |
POST/v1/recordings/{recordingId}/stop
Stop a recording; files arrive with the recording.ready webhook
Credential Project API key
| Parameter | In | Type | Required | Notes |
|---|---|---|---|---|
recordingId | path | string | Yes |
Next steps
- Conventions: base URL, errors, request ids, pagination.
- Errors: every error code and how to fix it.
- All endpoints: every endpoint on one page.