realtime-apps

List Realtime regions

Returns the regions a Realtime app can be created in. Use one of these identifiers as the region when creating an app.

get/v1/realtime/regions

Request

  • Base URL: https://us1.platform.bird.com
  • URL: https://us1.platform.bird.com/v1/realtime/regions
  • Auth: one of:
    • HTTP bearer
    • API key in cookie bird_session

Headers

X-Workspace-Idstring

Workspace context for the request. Required for dashboard authentication and master keys. Workspace keys and access tokens already identify their workspace; send that workspace or omit the header. A different one is rejected.

X-Organization-Idstring

Organization context for the request. Required for dashboard authentication. An API key or access token carries its own organization, so send either that organization or no header at all; a different one is rejected.

Response

The available Realtime regions.

Example response

{
  "data": [
    {
      "id": "us1"
    }
  ]
}

Changes

No recorded changes to this operation across all 2 revisions of this API.