Documentation
Sign inGet started

bird realtime apps keys

Usage

Exemplo de código
bird realtime apps keys

Description

A key's secret is readable only in the response that created it, so rotation runs add, roll out, revoke. An app holds several live keys at once for exactly that reason, and its last remaining key cannot be revoked.
Reads return JSON. Mutations take flags and/or a --body-file JSON body (flags overriding); run --example to print the body shape or --dry-run to preview the request.

Procedure

Rotate a Realtime app's keys with no downtime
An app accepts several live keys at once, so a rotation is add, roll out, then revoke. Revoking first breaks every client still holding the old key.
Requires: Nothing still uses the old key. Revocation takes effect immediately and the app has no grace period.
  1. bird realtime apps keys create — Existing keys keep working. The new key's secret is in this response only. Deploy the new key and secret to every client and server that connects. Next: bird realtime apps keys list
  2. bird realtime apps keys revoke — The key stops working at once; the record is kept with revoked_at set. An app's last remaining key cannot be revoked, so add the replacement first. Next: bird realtime apps keys list

Commands

NameDescription
createCreate a Realtime app key
listList a Realtime app's keys
revokeRevoke a Realtime app key