Sign inGet Started

List a Realtime app's keys

GET
/v1/realtime/apps/{realtime_app_id}/keys
bird realtime apps keys list <realtime-app-id>
Respuesta200
{
  "data": [
    {
      "id": "rak_01krdgeqcxet5s7t44vh8rt9mg",
      "key": "d0e95a856ddc1b09d4c8",
      "secret": "862925e1991a8b6902f9"
    }
  ]
}

Returns the app's keys, oldest first. Non-revoked only by default; pass include_revoked=true to include revoked keys. An app can hold several keys at once (create a new key, roll it out, then revoke the old one for zero-downtime rotation). Secrets are never included in this response.

Parámetros

realtime_app_idstring

ID of the Realtime app (rap_ prefix), as returned when the app was created.

Parámetros de consulta

include_revokedboolean

When true, include revoked keys in the response.

Carga de respuesta

data
array of object
obligatorio

The app's keys, oldest first. Revoked keys are excluded unless include_revoked=true.

Mostrar atributos secundarios
data.id
string
obligatorio
data.key
string
obligatorio

The public app key clients use to connect.

data.secret
string

The key secret, used for server-side request signing. Returned only when the key is created, and never shown again: store it securely. If lost, create a new key and revoke this one.

data.revoked_at
nullable string
obligatorio

When the key was revoked, or null if still active.

data.created_at
string
obligatorio

Continúa con la documentación, guías y ejemplos de este tema.