Management APIs / Regions

List regions

GEThttps://api.spice.ai/v1/regions

Returns the available regions where apps can be deployed.

Authorizations

  • AuthorizationstringRequired

    Bearer <token>. Authentication lists the tokens it accepts.

Header parameters

  • X-Org-Namestring

    The organization to act on, by handle. Omit it to act on the organization the credential is bound to; sending it blank is a 400, not the same as omitting it. A user credential may name any organization its owner belongs to; a machine credential is pinned to its own. A portal session token is bound to none, so it must send this header on every route but GET /v1/orgs (400 org_assertion_required otherwise).

    • Pattern: ^[A-Za-z0-9._-]{1,255}$

Responses

200List of available regionsapplication/json

  • regionsarray of object

    6 properties

    • namestring

      Human-readable region name

    • regionstring

      Region identifier (e.g., us-east-2)

    • providerstring

      • Allowed values: teraswitch, aws, azure

    • providerNamestring

      • Allowed values: Teraswitch, AWS, Azure

    • isDefaultboolean

    • disabledboolean

  • defaultstring

    The default region identifier

401Unauthorized

403Insufficient scope

OpenAPIapi.spice.ai/openapi.json

curl "https://api.spice.ai/v1/regions" \
  -H "Authorization: Bearer <token>"
{
  "regions": [
    {
      "name": "string",
      "region": "string",
      "provider": "teraswitch",
      "providerName": "Teraswitch",
      "isDefault": true,
      "disabled": true
    }
  ],
  "default": "string"
}

application/json