API reference

Regions

2 operations, generated from the OpenAPI document.

The regions workspaces can live in, and whether the caller may create one elsewhere

GET /api/regions

Access: any signed-in user, for their own data; signed-in session only (no personal access tokens).

Responses

  • 200 Success
    • current string required
    • regions array of object required
      • id string required
      • name string required
      • appUrl string (uri) required
    • createElsewhere boolean required
  • 401 Not signed in
  • 429 Too many requests: a rate limit was reached (see Retry-After)

Create a workspace in another region's stack, owned by the caller (Enterprise owners)

POST /api/regions/{regionId}/workspaces

Access: any signed-in user, for their own data; signed-in session only (no personal access tokens).

Parameters

NameInTypeRequired
regionIdpathstringyes

Request body

  • name string required

Responses

  • 201 Success
    • id string (uuid) required
    • name string required
    • region string required
    • url string (uri) required
  • 401 Not signed in
  • 422 The request failed validation
  • 429 Too many requests: a rate limit was reached (see Retry-After)