Skip to main content
GET
My keys
Universal endpoint for obtaining a list of tokens (API and WebSocket) and their rights/restrictions.

Authorization

The erlcrussia-api-key header is not strictly required if you are using a WebSocket key. You can pass:
  • erlcrussia-api-key - for authorization and working with HTTP API keys (?api=true).
  • erlcrussia-websocket-key - for authorization and working with WebSocket keys (?websocket=true).
  • Or both headings at the same time.

Query parameters

The restrictions=true parameter is bound to the preceding type parameter. For example:
  • ?api=true&restrictions=true - will return API keys with their restrictions.
  • ?api=true&websocket=true&restrictions=true - will return API keys without restrictions and WebSocket keys with restrictions.
  • ?api=true&restrictions=true&websocket=true&restrictions=true - will return both types of keys with restrictions.
The full secret is returned only on creation or rotation. AI key lists, renaming and deletion return a masked token. GET /keys reveals only the calling key; all sibling keys, including your own, are masked. teamId is the bound team ID or null.

Authorizations

erlcrussia-api-key
string
header
required

Custom API key. Store on the server; do not include client-side JavaScript.

Query Parameters

api
boolean

Запросить список HTTP API токенов

websocket
boolean

Запросить список WebSocket токенов

restrictions
boolean

Включить ограничения прав (указывается после api или websocket)

Response

List of requested keys (array or object when requesting api and websocket simultaneously).

api
object[]
websocket
object[]