Skip to main content
POST
Generate a WebSocket secret

Authorizations

Authorization
string
header
required

Bearer authentication header of the form Bearer <token>, where <token> is your auth token.

Path Parameters

orgId
string
required

Organization ID

Example:

"org-abc123"

Body

application/json
label
string
required

Human-readable label for the secret, e.g. "MacBook ops".

Maximum string length: 80
Example:

"MacBook ops"

Response

Secret created. The plaintext secret is included once and never again.

id
string
required
Example:

"rts-3f2b…"

label
string
required
Example:

"MacBook ops"

secret
string
required

Plaintext secret — shown ONCE. Copy it now; it is never retrievable again.

Example:

"wss_J8x…"

lastFour
string
required

Last 4 chars (the dashboard masks it as wss_…XXXX).

Example:

"a1B2"

createdAt
string<date-time>
required