Regions

List available deployment regions

Regions define where your Spice apps are deployed. Each region is operated by a cloud provider (AWS, Azure, or Teraswitch).

List Regions

GET https://api.spice.ai/v1/regions

Returns a list of available regions where apps can be deployed.

Required scope: apps:read

Response

200: OK

{
  "regions": [
    {
      "name": "US East (N. Virginia)",
      "region": "us-east-1",
      "provider": "aws",
      "providerName": "AWS",
      "cname": "us-east-1-prod-aws-data"
    },
    {
      "name": "US West (Oregon)",
      "region": "us-west-2",
      "provider": "aws",
      "providerName": "AWS",
      "cname": "us-west-2-prod-aws-data"
    }
  ],
  "default": "us-west-2"
}

Response Fields:

Field	Type	Description
name	string	Human-readable region name
region	string	Region identifier
cname	string	Region identifier used when creating apps
provider	string	Cloud provider (aws, azure, teraswitch)
providerName	string	Human-readable provider name
default	string	The default region identifier

401: Unauthorized

403: Forbidden

Examples

cURL:

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

Response:

{
  "regions": [
    {
      "name": "US East (N. Virginia)",
      "region": "us-east-1",
      "provider": "aws",
      "providerName": "AWS",
      "cname": "us-east-1-prod-aws-data"
    },
    {
      "name": "US West (Oregon)",
      "region": "us-west-2",
      "provider": "aws",
      "providerName": "AWS",
      "cname": "us-west-2-prod-aws-data"
    }
  ],
  "default": "us-west-2"
}

Python:

import requests

response = requests.get(
    "https://api.spice.ai/v1/regions",
    headers={"Authorization": f"Bearer {token}"}
)

regions = response.json()["regions"]
for region in regions:
    print(f"{region['name']} ({region['region']})")

Node.js:

const response = await fetch('https://api.spice.ai/v1/regions', {
  headers: {
    'Authorization': `Bearer ${token}`
  }
});

const data = await response.json();
console.log('Available regions:', data.regions);

Using Regions

When creating an app, use the cname field from the regions response:

curl -X POST https://api.spice.ai/v1/apps \
  -H "Authorization: Bearer <token>" \
  -H "Content-Type: application/json" \
  -d '{
    "name": "my-app",
    "cname": "us-west-2-prod-aws-data"
  }'

Region Selection

Consider these factors when selecting a region:

• Latency: Choose a region close to your users or data sources

• Compliance: Some regions may be required for data residency requirements

• Availability: Check region availability for your plan tier

The default region (us-east-2) is recommended for most use cases.