Management APIs

Regions

Available deployment regions

OpenAPIapi.spice.ai/openapi.json

List regions

GET/v1/regions

Returns the available regions where apps can be deployed.

Header parameters

NameTypeRequiredDescription
AuthorizationstringYes

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

X-Org-NamestringNo

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}$

Example request

curl "https://api.spice.ai/v1/regions" \
  -H "Authorization: Bearer <token>"

Responses

  • 200OK

    List of available regions

    application/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

    Unauthorized

  • 403Forbidden

    Insufficient scope