Skip to Content
LYNKORIADocs
HTTP API reference

Console (admin) API

The API behind the admin console. Every route needs a console session and the listed console role; responses are never cached. Generated from the OpenAPI specification.

The API behind the admin console. Every route needs a console session and the listed console role; responses are never cached.

POST /v1/admin/auth/login

Console sign-in. Accounts are provisioned by the operator CLI; there is no signup.

Authentication: None (public).

Request body (application/json, required)

FieldTypeRequiredNotes
emailstring (email)Yesmax length 320
passwordstringYesmin length 1; max length 1024

Response 204 No content

Errors: 400 Invalid request · 401 Missing or invalid credentials · 403 Not permitted · 404 Not found (including resources of other projects) · 429 Rate limit or quota exceeded. Error bodies follow the error format.

POST /v1/admin/auth/logout

Revoke the current console session.

Authentication: None (public).

Response 204 No content

Errors: 400 Invalid request · 401 Missing or invalid credentials · 403 Not permitted · 404 Not found (including resources of other projects) · 429 Rate limit or quota exceeded. Error bodies follow the error format.

GET /v1/admin/me

Authentication: Console session cookie; console role owner, admin, developer, auditor.

Response 200 OK

FieldTypeRequiredNotes
emailstringYes
rolesobject[]Yes
roles[].role"owner", "admin", "developer", "auditor"Yes
roles[].projectIdstring or nullYesnullable

Errors: 400 Invalid request · 401 Missing or invalid credentials · 403 Not permitted · 404 Not found (including resources of other projects) · 429 Rate limit or quota exceeded. Error bodies follow the error format.

GET /v1/admin/projects

Authentication: Console session cookie; console role owner, admin, developer, auditor.

Response 200 OK

FieldTypeRequiredNotes
[].idstring (uuid)Yes
[].slugstringYes
[].namestringYes
[].status"active", "disabled"Yes
[].createdAtstringYes
[].environmentsobject[]Yes
[].environments[].idstring (uuid)Yes
[].environments[].projectIdstring (uuid)Yes
[].environments[].environment"staging", "production"Yes
[].environments[].status"active", "disabled"Yes
[].environments[].allowedOriginsstring[]Yes
[].environments[].webhookUrlstring or nullYesnullable
[].environments[].webhookSecretConfiguredbooleanYes
[].environments[].livekitKeyRefstringYes
[].environments[].pushCredentialRefstring or nullYesnullable
[].environments[].featuresobjectYes
[].environments[].features.callsbooleanNodefault true
[].environments[].features.livestreambooleanNodefault false
[].environments[].features.messagingbooleanNodefault false
[].environments[].features.presencebooleanNodefault false
[].environments[].features.attachmentsbooleanNodefault false
[].environments[].features.singleDeviceCallsbooleanNodefault false
[].environments[].features.pushbooleanNodefault false
[].environments[].features.recordingbooleanNodefault false
[].environments[].limitsobjectYes
[].environments[].limits.maxRoomSizeintegerNo≥ 2; ≤ 1000; default 50
[].environments[].limits.maxConcurrentRoomsintegerNo≥ 1; ≤ 100000; default 100
[].environments[].limits.tokensPerMinuteintegerNo≥ 1; ≤ 100000; default 600
[].environments[].messagingPolicyobjectYes
[].environments[].messagingPolicy.allowDmsbooleanNodefault true
[].environments[].messagingPolicy.allowGroupsbooleanNodefault true
[].environments[].messagingPolicy.allowAttachmentsbooleanNodefault false
[].environments[].messagingPolicy.allowThreadsbooleanNodefault false
[].environments[].messagingPolicy.allowReactionsbooleanNodefault true
[].environments[].messagingPolicy.maxAttachmentBytesintegerNo≥ 1; ≤ 5368709120; default 26214400
[].environments[].messagingPolicy.allowedAttachmentTypesstring[]Noat most 50 items; default ["image/*","video/mp4","application/pdf"]
[].environments[].messagingPolicy.retentionDaysinteger or nullNo≥ 1; ≤ 36500; default null; nullable
[].environments[].createdAtstringYes
[].environments[].updatedAtstringYes

Errors: 400 Invalid request · 401 Missing or invalid credentials · 403 Not permitted · 404 Not found (including resources of other projects) · 429 Rate limit or quota exceeded. Error bodies follow the error format.

POST /v1/admin/projects

Authentication: Console session cookie; console role owner, admin.

Request body (application/json, required)

FieldTypeRequiredNotes
slugstringYespattern ^[a-z][a-z0-9-]{1,30}$
namestringYesmin length 1; max length 100

Response 201 Created

FieldTypeRequiredNotes
idstring (uuid)Yes
slugstringYes
namestringYes
status"active", "disabled"Yes
createdAtstringYes
environmentsobject[]Yes
environments[].idstring (uuid)Yes
environments[].projectIdstring (uuid)Yes
environments[].environment"staging", "production"Yes
environments[].status"active", "disabled"Yes
environments[].allowedOriginsstring[]Yes
environments[].webhookUrlstring or nullYesnullable
environments[].webhookSecretConfiguredbooleanYes
environments[].livekitKeyRefstringYes
environments[].pushCredentialRefstring or nullYesnullable
environments[].featuresobjectYes
environments[].features.callsbooleanNodefault true
environments[].features.livestreambooleanNodefault false
environments[].features.messagingbooleanNodefault false
environments[].features.presencebooleanNodefault false
environments[].features.attachmentsbooleanNodefault false
environments[].features.singleDeviceCallsbooleanNodefault false
environments[].features.pushbooleanNodefault false
environments[].features.recordingbooleanNodefault false
environments[].limitsobjectYes
environments[].limits.maxRoomSizeintegerNo≥ 2; ≤ 1000; default 50
environments[].limits.maxConcurrentRoomsintegerNo≥ 1; ≤ 100000; default 100
environments[].limits.tokensPerMinuteintegerNo≥ 1; ≤ 100000; default 600
environments[].messagingPolicyobjectYes
environments[].messagingPolicy.allowDmsbooleanNodefault true
environments[].messagingPolicy.allowGroupsbooleanNodefault true
environments[].messagingPolicy.allowAttachmentsbooleanNodefault false
environments[].messagingPolicy.allowThreadsbooleanNodefault false
environments[].messagingPolicy.allowReactionsbooleanNodefault true
environments[].messagingPolicy.maxAttachmentBytesintegerNo≥ 1; ≤ 5368709120; default 26214400
environments[].messagingPolicy.allowedAttachmentTypesstring[]Noat most 50 items; default ["image/*","video/mp4","application/pdf"]
environments[].messagingPolicy.retentionDaysinteger or nullNo≥ 1; ≤ 36500; default null; nullable
environments[].createdAtstringYes
environments[].updatedAtstringYes

Errors: 400 Invalid request · 401 Missing or invalid credentials · 403 Not permitted · 404 Not found (including resources of other projects) · 429 Rate limit or quota exceeded. Error bodies follow the error format.

GET /v1/admin/projects/{projectId}

Authentication: Console session cookie; console role owner, admin, developer, auditor.

Path parameters

FieldTypeRequiredNotes
projectIdstring (uuid)Yes

Response 200 OK

FieldTypeRequiredNotes
idstring (uuid)Yes
slugstringYes
namestringYes
status"active", "disabled"Yes
createdAtstringYes
environmentsobject[]Yes
environments[].idstring (uuid)Yes
environments[].projectIdstring (uuid)Yes
environments[].environment"staging", "production"Yes
environments[].status"active", "disabled"Yes
environments[].allowedOriginsstring[]Yes
environments[].webhookUrlstring or nullYesnullable
environments[].webhookSecretConfiguredbooleanYes
environments[].livekitKeyRefstringYes
environments[].pushCredentialRefstring or nullYesnullable
environments[].featuresobjectYes
environments[].features.callsbooleanNodefault true
environments[].features.livestreambooleanNodefault false
environments[].features.messagingbooleanNodefault false
environments[].features.presencebooleanNodefault false
environments[].features.attachmentsbooleanNodefault false
environments[].features.singleDeviceCallsbooleanNodefault false
environments[].features.pushbooleanNodefault false
environments[].features.recordingbooleanNodefault false
environments[].limitsobjectYes
environments[].limits.maxRoomSizeintegerNo≥ 2; ≤ 1000; default 50
environments[].limits.maxConcurrentRoomsintegerNo≥ 1; ≤ 100000; default 100
environments[].limits.tokensPerMinuteintegerNo≥ 1; ≤ 100000; default 600
environments[].messagingPolicyobjectYes
environments[].messagingPolicy.allowDmsbooleanNodefault true
environments[].messagingPolicy.allowGroupsbooleanNodefault true
environments[].messagingPolicy.allowAttachmentsbooleanNodefault false
environments[].messagingPolicy.allowThreadsbooleanNodefault false
environments[].messagingPolicy.allowReactionsbooleanNodefault true
environments[].messagingPolicy.maxAttachmentBytesintegerNo≥ 1; ≤ 5368709120; default 26214400
environments[].messagingPolicy.allowedAttachmentTypesstring[]Noat most 50 items; default ["image/*","video/mp4","application/pdf"]
environments[].messagingPolicy.retentionDaysinteger or nullNo≥ 1; ≤ 36500; default null; nullable
environments[].createdAtstringYes
environments[].updatedAtstringYes

Errors: 400 Invalid request · 401 Missing or invalid credentials · 403 Not permitted · 404 Not found (including resources of other projects) · 429 Rate limit or quota exceeded. Error bodies follow the error format.

PATCH /v1/admin/projects/{projectId}

Authentication: Console session cookie; console role owner, admin.

Path parameters

FieldTypeRequiredNotes
projectIdstring (uuid)Yes

Request body (application/json, required)

FieldTypeRequiredNotes
namestringNomin length 1; max length 100
status"active", "disabled"No

Response 200 OK

FieldTypeRequiredNotes
idstring (uuid)Yes
slugstringYes
namestringYes
status"active", "disabled"Yes
createdAtstringYes
environmentsobject[]Yes
environments[].idstring (uuid)Yes
environments[].projectIdstring (uuid)Yes
environments[].environment"staging", "production"Yes
environments[].status"active", "disabled"Yes
environments[].allowedOriginsstring[]Yes
environments[].webhookUrlstring or nullYesnullable
environments[].webhookSecretConfiguredbooleanYes
environments[].livekitKeyRefstringYes
environments[].pushCredentialRefstring or nullYesnullable
environments[].featuresobjectYes
environments[].features.callsbooleanNodefault true
environments[].features.livestreambooleanNodefault false
environments[].features.messagingbooleanNodefault false
environments[].features.presencebooleanNodefault false
environments[].features.attachmentsbooleanNodefault false
environments[].features.singleDeviceCallsbooleanNodefault false
environments[].features.pushbooleanNodefault false
environments[].features.recordingbooleanNodefault false
environments[].limitsobjectYes
environments[].limits.maxRoomSizeintegerNo≥ 2; ≤ 1000; default 50
environments[].limits.maxConcurrentRoomsintegerNo≥ 1; ≤ 100000; default 100
environments[].limits.tokensPerMinuteintegerNo≥ 1; ≤ 100000; default 600
environments[].messagingPolicyobjectYes
environments[].messagingPolicy.allowDmsbooleanNodefault true
environments[].messagingPolicy.allowGroupsbooleanNodefault true
environments[].messagingPolicy.allowAttachmentsbooleanNodefault false
environments[].messagingPolicy.allowThreadsbooleanNodefault false
environments[].messagingPolicy.allowReactionsbooleanNodefault true
environments[].messagingPolicy.maxAttachmentBytesintegerNo≥ 1; ≤ 5368709120; default 26214400
environments[].messagingPolicy.allowedAttachmentTypesstring[]Noat most 50 items; default ["image/*","video/mp4","application/pdf"]
environments[].messagingPolicy.retentionDaysinteger or nullNo≥ 1; ≤ 36500; default null; nullable
environments[].createdAtstringYes
environments[].updatedAtstringYes

Errors: 400 Invalid request · 401 Missing or invalid credentials · 403 Not permitted · 404 Not found (including resources of other projects) · 429 Rate limit or quota exceeded. Error bodies follow the error format.

POST /v1/admin/projects/{projectId}/environments

Authentication: Console session cookie; console role owner, admin.

Path parameters

FieldTypeRequiredNotes
projectIdstring (uuid)Yes

Request body (application/json, required)

FieldTypeRequiredNotes
environment"staging", "production"Yes
allowedOriginsstring (uri)[]Noat most 50 items; default []
webhookUrlstring (uri) or nullNodefault null; nullable
livekitKeyRefstringYesmin length 1; max length 100
pushCredentialRefstring or nullNomin length 1; max length 100; default null; nullable
featuresobjectNodefault {}
features.callsbooleanNodefault true
features.livestreambooleanNodefault false
features.messagingbooleanNodefault false
features.presencebooleanNodefault false
features.attachmentsbooleanNodefault false
features.singleDeviceCallsbooleanNodefault false
features.pushbooleanNodefault false
features.recordingbooleanNodefault false
limitsobjectNodefault {}
limits.maxRoomSizeintegerNo≥ 2; ≤ 1000; default 50
limits.maxConcurrentRoomsintegerNo≥ 1; ≤ 100000; default 100
limits.tokensPerMinuteintegerNo≥ 1; ≤ 100000; default 600
messagingPolicyobjectNodefault {}
messagingPolicy.allowDmsbooleanNodefault true
messagingPolicy.allowGroupsbooleanNodefault true
messagingPolicy.allowAttachmentsbooleanNodefault false
messagingPolicy.allowThreadsbooleanNodefault false
messagingPolicy.allowReactionsbooleanNodefault true
messagingPolicy.maxAttachmentBytesintegerNo≥ 1; ≤ 5368709120; default 26214400
messagingPolicy.allowedAttachmentTypesstring[]Noat most 50 items; default ["image/*","video/mp4","application/pdf"]
messagingPolicy.retentionDaysinteger or nullNo≥ 1; ≤ 36500; default null; nullable

Response 201 Created

FieldTypeRequiredNotes
idstring (uuid)Yes
projectIdstring (uuid)Yes
environment"staging", "production"Yes
status"active", "disabled"Yes
allowedOriginsstring[]Yes
webhookUrlstring or nullYesnullable
webhookSecretConfiguredbooleanYes
livekitKeyRefstringYes
pushCredentialRefstring or nullYesnullable
featuresobjectYes
features.callsbooleanNodefault true
features.livestreambooleanNodefault false
features.messagingbooleanNodefault false
features.presencebooleanNodefault false
features.attachmentsbooleanNodefault false
features.singleDeviceCallsbooleanNodefault false
features.pushbooleanNodefault false
features.recordingbooleanNodefault false
limitsobjectYes
limits.maxRoomSizeintegerNo≥ 2; ≤ 1000; default 50
limits.maxConcurrentRoomsintegerNo≥ 1; ≤ 100000; default 100
limits.tokensPerMinuteintegerNo≥ 1; ≤ 100000; default 600
messagingPolicyobjectYes
messagingPolicy.allowDmsbooleanNodefault true
messagingPolicy.allowGroupsbooleanNodefault true
messagingPolicy.allowAttachmentsbooleanNodefault false
messagingPolicy.allowThreadsbooleanNodefault false
messagingPolicy.allowReactionsbooleanNodefault true
messagingPolicy.maxAttachmentBytesintegerNo≥ 1; ≤ 5368709120; default 26214400
messagingPolicy.allowedAttachmentTypesstring[]Noat most 50 items; default ["image/*","video/mp4","application/pdf"]
messagingPolicy.retentionDaysinteger or nullNo≥ 1; ≤ 36500; default null; nullable
createdAtstringYes
updatedAtstringYes

Errors: 400 Invalid request · 401 Missing or invalid credentials · 403 Not permitted · 404 Not found (including resources of other projects) · 429 Rate limit or quota exceeded. Error bodies follow the error format.

PATCH /v1/admin/projects/{projectId}/environments/{envId}

Authentication: Console session cookie; console role owner, admin.

Path parameters

FieldTypeRequiredNotes
projectIdstring (uuid)Yes
envIdstring (uuid)Yes

Request body (application/json, required)

FieldTypeRequiredNotes
status"active", "disabled"No
allowedOriginsstring (uri)[]Noat most 50 items
webhookUrlstring (uri) or nullNonullable
livekitKeyRefstringNomin length 1; max length 100
pushCredentialRefstring or nullNomin length 1; max length 100; nullable
featuresobjectNo
features.callsbooleanNo
features.livestreambooleanNo
features.messagingbooleanNo
features.presencebooleanNo
features.attachmentsbooleanNo
features.singleDeviceCallsbooleanNo
features.pushbooleanNo
features.recordingbooleanNo
limitsobjectNo
limits.maxRoomSizeintegerNo≥ 2; ≤ 1000
limits.maxConcurrentRoomsintegerNo≥ 1; ≤ 100000
limits.tokensPerMinuteintegerNo≥ 1; ≤ 100000
messagingPolicyobjectNo
messagingPolicy.allowDmsbooleanNo
messagingPolicy.allowGroupsbooleanNo
messagingPolicy.allowAttachmentsbooleanNo
messagingPolicy.allowThreadsbooleanNo
messagingPolicy.allowReactionsbooleanNo
messagingPolicy.maxAttachmentBytesintegerNo≥ 1; ≤ 5368709120
messagingPolicy.allowedAttachmentTypesstring[]Noat most 50 items
messagingPolicy.retentionDaysinteger or nullNo≥ 1; ≤ 36500; nullable

Response 200 OK

FieldTypeRequiredNotes
idstring (uuid)Yes
projectIdstring (uuid)Yes
environment"staging", "production"Yes
status"active", "disabled"Yes
allowedOriginsstring[]Yes
webhookUrlstring or nullYesnullable
webhookSecretConfiguredbooleanYes
livekitKeyRefstringYes
pushCredentialRefstring or nullYesnullable
featuresobjectYes
features.callsbooleanNodefault true
features.livestreambooleanNodefault false
features.messagingbooleanNodefault false
features.presencebooleanNodefault false
features.attachmentsbooleanNodefault false
features.singleDeviceCallsbooleanNodefault false
features.pushbooleanNodefault false
features.recordingbooleanNodefault false
limitsobjectYes
limits.maxRoomSizeintegerNo≥ 2; ≤ 1000; default 50
limits.maxConcurrentRoomsintegerNo≥ 1; ≤ 100000; default 100
limits.tokensPerMinuteintegerNo≥ 1; ≤ 100000; default 600
messagingPolicyobjectYes
messagingPolicy.allowDmsbooleanNodefault true
messagingPolicy.allowGroupsbooleanNodefault true
messagingPolicy.allowAttachmentsbooleanNodefault false
messagingPolicy.allowThreadsbooleanNodefault false
messagingPolicy.allowReactionsbooleanNodefault true
messagingPolicy.maxAttachmentBytesintegerNo≥ 1; ≤ 5368709120; default 26214400
messagingPolicy.allowedAttachmentTypesstring[]Noat most 50 items; default ["image/*","video/mp4","application/pdf"]
messagingPolicy.retentionDaysinteger or nullNo≥ 1; ≤ 36500; default null; nullable
createdAtstringYes
updatedAtstringYes

Errors: 400 Invalid request · 401 Missing or invalid credentials · 403 Not permitted · 404 Not found (including resources of other projects) · 429 Rate limit or quota exceeded. Error bodies follow the error format.

POST /v1/admin/projects/{projectId}/environments/{envId}/webhook-secret

Rotate the product webhook signing secret. The secret is shown once.

Authentication: Console session cookie; console role owner, admin.

Path parameters

FieldTypeRequiredNotes
projectIdstring (uuid)Yes
envIdstring (uuid)Yes

Response 200 OK

FieldTypeRequiredNotes
secretstringYes
versionintegerYes

Errors: 400 Invalid request · 401 Missing or invalid credentials · 403 Not permitted · 404 Not found (including resources of other projects) · 429 Rate limit or quota exceeded. Error bodies follow the error format.

GET /v1/admin/projects/{projectId}/keys

Authentication: Console session cookie; console role owner, admin, developer, auditor.

Path parameters

FieldTypeRequiredNotes
projectIdstring (uuid)Yes

Response 200 OK

FieldTypeRequiredNotes
[].idstringYes
[].environmentIdstring (uuid)Yes
[].mode"live", "test"Yes
[].displayNamestringYes
[].prefixstringYes
[].suffixstringYes
[].scopesstring[]Yes
[].expiresAtstring or nullYesnullable
[].revokedAtstring or nullYesnullable
[].lastUsedAtstring or nullYesnullable
[].createdBystringYes
[].createdAtstringYes

Errors: 400 Invalid request · 401 Missing or invalid credentials · 403 Not permitted · 404 Not found (including resources of other projects) · 429 Rate limit or quota exceeded. Error bodies follow the error format.

POST /v1/admin/projects/{projectId}/keys

Create a service key. The secret is returned once and never again.

Authentication: Console session cookie; console role owner, admin.

Path parameters

FieldTypeRequiredNotes
projectIdstring (uuid)Yes

Request body (application/json, required)

FieldTypeRequiredNotes
environmentIdstring (uuid)Yes
displayNamestringYesmin length 1; max length 100
scopes"calls:write", "messaging:write", "users:write"[]Noat least 1 items; default ["calls:write","messaging:write","users:write"]
expiresAtstring (date-time) or nullNodefault null; nullable

Response 201 Created

FieldTypeRequiredNotes
keyobjectYes
key.idstringYes
key.environmentIdstring (uuid)Yes
key.mode"live", "test"Yes
key.displayNamestringYes
key.prefixstringYes
key.suffixstringYes
key.scopesstring[]Yes
key.expiresAtstring or nullYesnullable
key.revokedAtstring or nullYesnullable
key.lastUsedAtstring or nullYesnullable
key.createdBystringYes
key.createdAtstringYes
secretstringYes

Errors: 400 Invalid request · 401 Missing or invalid credentials · 403 Not permitted · 404 Not found (including resources of other projects) · 429 Rate limit or quota exceeded. Error bodies follow the error format.

POST /v1/admin/projects/{projectId}/keys/{id}/rotate

Create a replacement key; the old key stays active until revoked (zero-downtime rotation).

Authentication: Console session cookie; console role owner, admin.

Path parameters

FieldTypeRequiredNotes
projectIdstring (uuid)Yes
idstringYespattern ^[A-Za-z0-9]{12}$

Response 201 Created

FieldTypeRequiredNotes
keyobjectYes
key.idstringYes
key.environmentIdstring (uuid)Yes
key.mode"live", "test"Yes
key.displayNamestringYes
key.prefixstringYes
key.suffixstringYes
key.scopesstring[]Yes
key.expiresAtstring or nullYesnullable
key.revokedAtstring or nullYesnullable
key.lastUsedAtstring or nullYesnullable
key.createdBystringYes
key.createdAtstringYes
secretstringYes

Errors: 400 Invalid request · 401 Missing or invalid credentials · 403 Not permitted · 404 Not found (including resources of other projects) · 429 Rate limit or quota exceeded. Error bodies follow the error format.

DELETE /v1/admin/projects/{projectId}/keys/{id}

Revoke a service key (effective on the next request).

Authentication: Console session cookie; console role owner, admin.

Path parameters

FieldTypeRequiredNotes
projectIdstring (uuid)Yes
idstringYespattern ^[A-Za-z0-9]{12}$

Response 204 No content

Errors: 400 Invalid request · 401 Missing or invalid credentials · 403 Not permitted · 404 Not found (including resources of other projects) · 429 Rate limit or quota exceeded. Error bodies follow the error format.

GET /v1/admin/projects/{projectId}/usage

Authentication: Console session cookie; console role owner, admin, developer, auditor.

Path parameters

FieldTypeRequiredNotes
projectIdstring (uuid)Yes

Query parameters

FieldTypeRequiredNotes
envstring (uuid)No
fromstring (date)No
tostring (date)No

Response 200 OK

FieldTypeRequiredNotes
[].environmentIdstring (uuid)Yes
[].datestringYes
[].callCountnumberYes
[].participantMinutesnumberYes
[].peakParticipantsnumberYes
[].apiRequestsnumberYes
[].apiErrorsnumberYes
[].tokensIssuednumberYes
[].messagesSentnumberYes

Errors: 400 Invalid request · 401 Missing or invalid credentials · 403 Not permitted · 404 Not found (including resources of other projects) · 429 Rate limit or quota exceeded. Error bodies follow the error format.

GET /v1/admin/projects/{projectId}/usage/export

Daily usage as CSV (at most 400 days). Built on the server and recorded in the audit log.

Authentication: Console session cookie; console role owner, admin, developer, auditor.

Path parameters

FieldTypeRequiredNotes
projectIdstring (uuid)Yes

Query parameters

FieldTypeRequiredNotes
envstring (uuid)No
fromstring (date)No
tostring (date)No

Response 200 CSV

Body: string

Errors: 400 Invalid request · 401 Missing or invalid credentials · 403 Not permitted · 404 Not found (including resources of other projects) · 429 Rate limit or quota exceeded. Error bodies follow the error format.

GET /v1/admin/projects/{projectId}/webhook-deliveries

Pending or dead-lettered outbound webhook deliveries.

Authentication: Console session cookie; console role owner, admin, developer, auditor.

Path parameters

FieldTypeRequiredNotes
projectIdstring (uuid)Yes

Query parameters

FieldTypeRequiredNotes
status"pending", "dead"Nodefault "dead"

Response 200 OK

FieldTypeRequiredNotes
[].idstring (uuid)Yes
[].environmentIdstring (uuid)Yes
[].typestringYes
[].attemptsintegerYes
[].lastErrorstring or nullYesnullable
[].createdAtstringYes
[].availableAtstringYes
[].deliveredAtstring or nullYesnullable
[].deadAtstring or nullYesnullable

Errors: 400 Invalid request · 401 Missing or invalid credentials · 403 Not permitted · 404 Not found (including resources of other projects) · 429 Rate limit or quota exceeded. Error bodies follow the error format.

GET /v1/admin/projects/{projectId}/operations

Recent push deliveries, recordings and attachment scan results (no secrets or content).

Authentication: Console session cookie; console role owner, admin, developer, auditor.

Path parameters

FieldTypeRequiredNotes
projectIdstring (uuid)Yes

Response 200 OK

FieldTypeRequiredNotes
pushDeliveriesobject[]Yes
pushDeliveries[].idstring (uuid)Yes
pushDeliveries[].environmentIdstring (uuid)Yes
pushDeliveries[].provider"fcm", "apns", "apns_voip"Yes
pushDeliveries[].kindstringYes
pushDeliveries[].status"pending", "sent", "failed", "dead"Yes
pushDeliveries[].attemptsintegerYes
pushDeliveries[].lastErrorstring or nullYesnullable
pushDeliveries[].createdAtstringYes
pushDeliveries[].sentAtstring or nullYesnullable
recordingsobject[]Yes
recordings[].idstring (uuid)Yes
recordings[].callIdstring (uuid)Yes
recordings[].kind"room_composite", "participant", "audio_only"Yes
recordings[].outputsstring[]Yes
recordings[].status"starting", "active", "ending", "complete", "failed", "aborted", "deleted"Yes
recordings[].filesobject[]Yes
recordings[].files[].namestringYes
recordings[].files[].sizeinteger or nullYesnullable
recordings[].files[].durationMsinteger or nullYesnullable
recordings[].errorstring or nullYesnullable
recordings[].startedAtstring or nullYesnullable
recordings[].endedAtstring or nullYesnullable
recordings[].expiresAtstring or nullYesnullable
recordings[].createdAtstringYes
scansobjectYes
scans.countsmapYes
scans.recentobject[]Yes
scans.recent[].idstring (uuid)Yes
scans.recent[].environmentIdstring (uuid)Yes
scans.recent[].scanStatusstringYes
scans.recent[].detectedTypestring or nullYesnullable
scans.recent[].scanDetailstring or nullYesnullable
scans.recent[].sizeintegerYes
scans.recent[].scannedAtstring or nullYesnullable

Errors: 400 Invalid request · 401 Missing or invalid credentials · 403 Not permitted · 404 Not found (including resources of other projects) · 429 Rate limit or quota exceeded. Error bodies follow the error format.

POST /v1/admin/projects/{projectId}/webhook-deliveries/{eventId}/retry

Authentication: Console session cookie; console role owner, admin.

Path parameters

FieldTypeRequiredNotes
projectIdstring (uuid)Yes
eventIdstring (uuid)Yes

Response 204 No content

Errors: 400 Invalid request · 401 Missing or invalid credentials · 403 Not permitted · 404 Not found (including resources of other projects) · 429 Rate limit or quota exceeded. Error bodies follow the error format.

GET /v1/admin/audit-logs

Authentication: Console session cookie; console role owner, admin, auditor.

Query parameters

FieldTypeRequiredNotes
projectIdstring (uuid)No
actionstringNomax length 100
actorstringNomax length 320
fromstring (date-time)No
tostring (date-time)No
beforestringNomax length 200
limitintegerNo≥ 1; ≤ 200; default 50

Response 200 OK

FieldTypeRequiredNotes
itemsobject[]Yes
items[].idstring (uuid)Yes
items[].actorstringYes
items[].projectIdstring or nullYesnullable
items[].actionstringYes
items[].targetTypestringYes
items[].targetIdstring or nullYesnullable
items[].ipstring or nullYesnullable
items[].userAgentstring or nullYesnullable
items[].requestIdstring or nullYesnullable
items[].metadatamapYes
items[].createdAtstringYes
nextBeforestring or nullYesnullable

Errors: 400 Invalid request · 401 Missing or invalid credentials · 403 Not permitted · 404 Not found (including resources of other projects) · 429 Rate limit or quota exceeded. Error bodies follow the error format.

GET /v1/admin/roles

Authentication: Console session cookie; console role owner, admin, auditor.

Response 200 OK

FieldTypeRequiredNotes
[].idstring (uuid)Yes
[].emailstringYes
[].role"owner", "admin", "developer", "auditor"Yes
[].projectIdstring or nullYesnullable
[].createdAtstringYes
[].lastActivityAtstring or nullNonullable

Errors: 400 Invalid request · 401 Missing or invalid credentials · 403 Not permitted · 404 Not found (including resources of other projects) · 429 Rate limit or quota exceeded. Error bodies follow the error format.

POST /v1/admin/roles

Authentication: Console session cookie; console role owner.

Request body (application/json, required)

FieldTypeRequiredNotes
emailstring (email)Yes
role"owner", "admin", "developer", "auditor"Yes
projectIdstring (uuid) or nullNodefault null; nullable

Response 201 Created

FieldTypeRequiredNotes
idstring (uuid)Yes
emailstringYes
role"owner", "admin", "developer", "auditor"Yes
projectIdstring or nullYesnullable
createdAtstringYes
lastActivityAtstring or nullNonullable

Errors: 400 Invalid request · 401 Missing or invalid credentials · 403 Not permitted · 404 Not found (including resources of other projects) · 429 Rate limit or quota exceeded. Error bodies follow the error format.

DELETE /v1/admin/roles/{id}

Authentication: Console session cookie; console role owner.

Path parameters

FieldTypeRequiredNotes
idstring (uuid)Yes

Response 204 No content

Errors: 400 Invalid request · 401 Missing or invalid credentials · 403 Not permitted · 404 Not found (including resources of other projects) · 429 Rate limit or quota exceeded. Error bodies follow the error format.

GET /v1/admin/me/sessions

The signed-in user's active console sessions.

Authentication: Console session cookie; console role owner, admin, developer, auditor.

Response 200 OK

FieldTypeRequiredNotes
itemsobject[]Yes
items[].idstringYes
items[].currentbooleanYes
items[].createdAtstringYes
items[].lastSeenAtstringYes
items[].expiresAtstringYes
items[].ipstring or nullYesnullable
items[].userAgentstring or nullYesnullable

Errors: 400 Invalid request · 401 Missing or invalid credentials · 403 Not permitted · 404 Not found (including resources of other projects) · 429 Rate limit or quota exceeded. Error bodies follow the error format.

DELETE /v1/admin/me/sessions/{id}

End one of the signed-in user's own sessions (signs that browser out).

Authentication: Console session cookie; console role owner, admin, developer, auditor.

Path parameters

FieldTypeRequiredNotes
idstringYespattern ^[A-Za-z0-9_-]{43}$

Response 204 No content

Errors: 400 Invalid request · 401 Missing or invalid credentials · 403 Not permitted · 404 Not found (including resources of other projects) · 429 Rate limit or quota exceeded. Error bodies follow the error format.

GET /v1/admin/me/activity

The signed-in user's recent sign-ins, failed sign-ins, sign-outs and revocations.

Authentication: Console session cookie; console role owner, admin, developer, auditor.

Response 200 OK

FieldTypeRequiredNotes
itemsobject[]Yes
items[].idstring (uuid)Yes
items[].actorstringYes
items[].projectIdstring or nullYesnullable
items[].actionstringYes
items[].targetTypestringYes
items[].targetIdstring or nullYesnullable
items[].ipstring or nullYesnullable
items[].userAgentstring or nullYesnullable
items[].requestIdstring or nullYesnullable
items[].metadatamapYes
items[].createdAtstringYes

Errors: 400 Invalid request · 401 Missing or invalid credentials · 403 Not permitted · 404 Not found (including resources of other projects) · 429 Rate limit or quota exceeded. Error bodies follow the error format.

GET /v1/admin/usage

Usage over time for every readable project (or one project or environment), in hourly (up to 7 days, last 35 days) or daily (up to 400 days) buckets, with per-project totals.

Authentication: Console session cookie; console role owner, admin, developer, auditor.

Query parameters

FieldTypeRequiredNotes
bucket"hour", "day"Nodefault "day"
fromstringYesmax length 40
tostringYesmax length 40
projectstring (uuid)No
envstring (uuid)No

Response 200 OK

FieldTypeRequiredNotes
bucket"hour", "day"Yes
fromstringYes
tostringYes
sincestring or nullYesnullable
pointsobject[]Yes
points[].callCountnumberYes
points[].participantMinutesnumberYes
points[].peakParticipantsnumberYes
points[].messagesSentnumberYes
points[].tokensIssuednumberYes
points[].apiRequestsnumberYes
points[].apiErrorsnumberYes
points[].bucketstringYes
totalsobjectYes
totals.callCountnumberYes
totals.participantMinutesnumberYes
totals.peakParticipantsnumberYes
totals.messagesSentnumberYes
totals.tokensIssuednumberYes
totals.apiRequestsnumberYes
totals.apiErrorsnumberYes
byProjectobject[]Yes
byProject[].callCountnumberYes
byProject[].participantMinutesnumberYes
byProject[].peakParticipantsnumberYes
byProject[].messagesSentnumberYes
byProject[].tokensIssuednumberYes
byProject[].apiRequestsnumberYes
byProject[].apiErrorsnumberYes
byProject[].projectIdstring (uuid)Yes

Errors: 400 Invalid request · 401 Missing or invalid credentials · 403 Not permitted · 404 Not found (including resources of other projects) · 429 Rate limit or quota exceeded. Error bodies follow the error format.

GET /v1/admin/live

Current activity per readable project: active calls and livestreams, connected participants, livestream audience, possibly stale calls and webhook backlog.

Authentication: Console session cookie; console role owner, admin, developer, auditor.

Response 200 OK

FieldTypeRequiredNotes
generatedAtstringYes
projectsobject[]Yes
projects[].projectIdstring (uuid)Yes
projects[].activeCallsintegerYes
projects[].livestreamsintegerYes
projects[].connectedParticipantsintegerYes
projects[].livestreamAudienceintegerYes
projects[].staleCallsintegerYes
projects[].webhooksPendingintegerYes
projects[].webhooksDeadintegerYes

Errors: 400 Invalid request · 401 Missing or invalid credentials · 403 Not permitted · 404 Not found (including resources of other projects) · 429 Rate limit or quota exceeded. Error bodies follow the error format.

GET /v1/admin/projects/{projectId}/calls

Calls and livestreams, newest first, with connected and total participant counts.

Authentication: Console session cookie; console role owner, admin, developer, auditor.

Path parameters

FieldTypeRequiredNotes
projectIdstring (uuid)Yes

Query parameters

FieldTypeRequiredNotes
status"active", "ended", "all"Nodefault "active"
type"one_to_one", "group", "livestream"No
envstring (uuid)No
qstringNomax length 128
cursorstringNomax length 200
limitintegerNo≥ 1; ≤ 100; default 50

Response 200 OK

FieldTypeRequiredNotes
itemsobject[]Yes
items[].idstring (uuid)Yes
items[].environmentIdstring (uuid)Yes
items[].tenantIdstringYes
items[].productCallIdstringYes
items[].type"one_to_one", "group", "livestream"Yes
items[].status"active", "ended"Yes
items[].maxParticipantsintegerYes
items[].e2eebooleanYes
items[].startedAtstringYes
items[].endedAtstring or nullYesnullable
items[].durationSecondsintegerYes
items[].connectedintegerYes
items[].participantSessionsintegerYes
items[].stalebooleanYes
nextCursorstring or nullYesnullable

Errors: 400 Invalid request · 401 Missing or invalid credentials · 403 Not permitted · 404 Not found (including resources of other projects) · 429 Rate limit or quota exceeded. Error bodies follow the error format.

GET /v1/admin/projects/{projectId}/calls/{callId}

One call with its participant sessions (identities only; no media or messages).

Authentication: Console session cookie; console role owner, admin, developer, auditor.

Path parameters

FieldTypeRequiredNotes
projectIdstring (uuid)Yes
callIdstring (uuid)Yes

Response 200 OK

FieldTypeRequiredNotes
callobjectYes
call.idstring (uuid)Yes
call.environmentIdstring (uuid)Yes
call.tenantIdstringYes
call.productCallIdstringYes
call.type"one_to_one", "group", "livestream"Yes
call.status"active", "ended"Yes
call.maxParticipantsintegerYes
call.e2eebooleanYes
call.startedAtstringYes
call.endedAtstring or nullYesnullable
call.durationSecondsintegerYes
call.connectedintegerYes
call.participantSessionsintegerYes
call.stalebooleanYes
participantsobject[]Yes
participants[].identitystringYes
participants[].userIdstringYes
participants[].deviceIdstringYes
participants[].joinedAtstringYes
participants[].leftAtstring or nullYesnullable
participants[].durationSecondsintegerYes
participantTotalintegerYes

Errors: 400 Invalid request · 401 Missing or invalid credentials · 403 Not permitted · 404 Not found (including resources of other projects) · 429 Rate limit or quota exceeded. Error bodies follow the error format.

POST /v1/admin/projects/{projectId}/calls/{callId}/end

End a call for everyone: disconnects participants, stops new join tokens and sends call.ended (reason ended_by_console).

Authentication: Console session cookie; console role owner, admin.

Path parameters

FieldTypeRequiredNotes
projectIdstring (uuid)Yes
callIdstring (uuid)Yes

Response 204 No content

Errors: 400 Invalid request · 401 Missing or invalid credentials · 403 Not permitted · 404 Not found (including resources of other projects) · 429 Rate limit or quota exceeded. Error bodies follow the error format.

POST /v1/admin/projects/{projectId}/calls/{callId}/participants/{identity}/remove

Disconnect one participant device from an active call.

Authentication: Console session cookie; console role owner, admin.

Path parameters

FieldTypeRequiredNotes
projectIdstring (uuid)Yes
callIdstring (uuid)Yes
identitystringYesmin length 3; max length 400

Response 204 No content

Errors: 400 Invalid request · 401 Missing or invalid credentials · 403 Not permitted · 404 Not found (including resources of other projects) · 429 Rate limit or quota exceeded. Error bodies follow the error format.

GET /v1/admin/projects/{projectId}/live

Current activity per environment: active calls by type, connected participants, livestream audience, possibly stale calls, quota limits and webhook backlog.

Authentication: Console session cookie; console role owner, admin, developer, auditor.

Path parameters

FieldTypeRequiredNotes
projectIdstring (uuid)Yes

Response 200 OK

FieldTypeRequiredNotes
generatedAtstringYes
environmentsobject[]Yes
environments[].environmentIdstring (uuid)Yes
environments[].environment"staging", "production"Yes
environments[].activeCallsobjectYes
environments[].activeCalls.totalintegerYes
environments[].activeCalls.one_to_oneintegerYes
environments[].activeCalls.groupintegerYes
environments[].activeCalls.livestreamintegerYes
environments[].connectedParticipantsintegerYes
environments[].livestreamAudienceintegerYes
environments[].staleCallsintegerYes
environments[].limitsobjectYes
environments[].limits.maxRoomSizeintegerNo≥ 2; ≤ 1000; default 50
environments[].limits.maxConcurrentRoomsintegerNo≥ 1; ≤ 100000; default 100
environments[].limits.tokensPerMinuteintegerNo≥ 1; ≤ 100000; default 600
environments[].webhooksobjectYes
environments[].webhooks.pendingintegerYes
environments[].webhooks.deadintegerYes
environments[].webhooks.oldestPendingAtstring or nullYesnullable

Errors: 400 Invalid request · 401 Missing or invalid credentials · 403 Not permitted · 404 Not found (including resources of other projects) · 429 Rate limit or quota exceeded. Error bodies follow the error format.

GET /v1/admin/projects/{projectId}/webhook-events

Outbound webhook deliveries by status (pending, dead or delivered), newest first, paginated. Payloads and secrets are never returned.

Authentication: Console session cookie; console role owner, admin, developer, auditor.

Path parameters

FieldTypeRequiredNotes
projectIdstring (uuid)Yes

Query parameters

FieldTypeRequiredNotes
status"pending", "dead", "delivered"Nodefault "dead"
envstring (uuid)No
cursorstringNomax length 200
limitintegerNo≥ 1; ≤ 100; default 50

Response 200 OK

FieldTypeRequiredNotes
itemsobject[]Yes
items[].idstring (uuid)Yes
items[].environmentIdstring (uuid)Yes
items[].typestringYes
items[].attemptsintegerYes
items[].lastErrorstring or nullYesnullable
items[].createdAtstringYes
items[].availableAtstringYes
items[].deliveredAtstring or nullYesnullable
items[].deadAtstring or nullYesnullable
nextCursorstring or nullYesnullable

Errors: 400 Invalid request · 401 Missing or invalid credentials · 403 Not permitted · 404 Not found (including resources of other projects) · 429 Rate limit or quota exceeded. Error bodies follow the error format.

On this page