Sign inGet Started
Get started
Guides
API Reference
SDKs
CLI
Knowledge Base
Changelog

Create a Realtime app key

POST
/v1/realtime/apps/{realtime_app_id}/keys
bird realtime apps keys create <realtime-app-id>
Response201
{
  "id": "rak_01krdgeqcxet5s7t44vh8rt9mg",
  "key": "d0e95a856ddc1b09d4c8",
  "secret": "862925e1991a8b6902f9"
}

Adds a new key to the app and returns it with its secret. Store the secret when you receive it because later responses do not include it. Use this together with revoke for zero-downtime rotation: add a key, roll it out across your clients, then revoke the old key.

Parameters

realtime_app_idstring

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

Response Payload

id
string
required
key
string
required

The public app key clients use to connect.

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.

revoked_at
nullable string
required

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

created_at
string
required

Related resources

Continue with the documentation, guides and examples for this topic.

Try the practice and get an implementation brief