Skip to main content
POST
Create Channel

Authorizations

Authorization
string
header
required

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

Path Parameters

orgId
string
required

The organization's id (UUID) or slug — either form is accepted.

projectId
string
required

The project's id (UUID) or slug — either form is accepted.

Query Parameters

environment
string

Environment slug to scope this operation to. Defaults to "production". An environment that does not exist on the project answers 404. The channel is created in this environment.

Pattern: ^[a-z][a-z0-9-]{0,38}$

Body

application/json
name
string
required
Pattern: ^[a-z][a-z0-9-]{1,61}$
region
enum<string>
Available options:
global
retentionSeconds
integer
Required range: 0 <= x <= 86400
presenceEnabled
boolean
maxConnections
integer
Required range: 1 <= x <= 10000
maxMessagesPerSecond
integer
Required range: 1 <= x <= 2500

Response

Channel ready.

id
string
required
name
string
required
Pattern: ^[a-z][a-z0-9-]{1,61}$
environment
string
required
status
enum<string>
required
Available options:
ready,
paused,
failed
region
enum<string>
required

Realtime channels are globally routed. The platform does not promise a storage jurisdiction.

Available options:
global
retentionSeconds
integer
required
Required range: 0 <= x <= 86400
presenceEnabled
boolean
required
maxConnections
integer
required
Required range: 1 <= x <= 10000
maxMessagesPerSecond
integer
required
Required range: 1 <= x <= 2500
deliveryGuarantee
enum<string>
required
Available options:
at-most-once-live
createdAt
string<date-time>
required
updatedAt
string<date-time>
required