List cluster locations
GET
/cluster-locations
const url = 'http://localhost:8000/cluster-locations';
const options = {
method: 'GET',
headers: {'API-Version': '2026-06-01.beta', 'API-Key': '<API-Key>'}
};
try {
const response = await fetch(url, options);
const data = await response.json();
console.log(data);
} catch (error) {
console.error(error);
}curl --request GET \
--url http://localhost:8000/cluster-locations \
--header 'API-Key: <API-Key>' \
--header 'API-Version: 2026-06-01.beta'Returns metadata for all supported deployment regions.
Authorizations
Section titled “Authorizations”Parameters
Section titled “Parameters”Header Parameters
Section titled “Header Parameters”API-Version
required
string
Responses
Section titled “Responses”The request has succeeded.
Media typeapplication/json
Array<object>
Metadata about a supported deployment region.
object
location
required
Region where the cluster is hosted.
string
name
required
Human-readable region name.
string
available
required
Whether the workspace can create a cluster in this region. Regions the workspace cannot use are still listed, with this field set to false.
boolean
Example
[
{
"location": "us"
}
]Access is unauthorized.
Media typeapplication/problem+json
RFC 9457 Problem Details object.
object
type
required
string format: uri
title
required
string
status
required
integer
detail
required
string
instance
string format: uri
Example generated
{
"type": "https://example.com",
"title": "example",
"status": 1,
"detail": "example",
"instance": "https://example.com"
}Client error
Media typeapplication/problem+json
RFC 9457 Problem Details object.
object
type
required
string format: uri
title
required
string
status
required
integer
detail
required
string
instance
string format: uri
Example generated
{
"type": "https://example.com",
"title": "example",
"status": 1,
"detail": "example",
"instance": "https://example.com"
}Headers
Section titled “Headers”Retry-After
integer
RateLimit-Limit
integer
RateLimit-Remaining
integer
RateLimit-Reset
integer
X-RateLimit-Limit-Second
integer
X-RateLimit-Remaining-Second
integer
X-RateLimit-Limit-Minute
integer
X-RateLimit-Remaining-Minute
integer
X-RateLimit-Limit-Hour
integer
X-RateLimit-Remaining-Hour
integer
X-RateLimit-Limit-Day
integer
X-RateLimit-Remaining-Day
integer
Server error
Media typeapplication/problem+json
RFC 9457 Problem Details object.
object
type
required
string format: uri
title
required
string
status
required
integer
detail
required
string
instance
string format: uri
Example generated
{
"type": "https://example.com",
"title": "example",
"status": 1,
"detail": "example",
"instance": "https://example.com"
}Server error
Media typeapplication/problem+json
RFC 9457 Problem Details object.
object
type
required
string format: uri
title
required
string
status
required
integer
detail
required
string
instance
string format: uri
Example generated
{
"type": "https://example.com",
"title": "example",
"status": 1,
"detail": "example",
"instance": "https://example.com"
}