How to Check Cluster Availability by Region

Checking cluster availability returns the available cluster types and plans for a specific region. This is useful for determining which regions support a Compute Cluster, Bare Metal Cluster, or GPU Fabric Cluster before creating one.

This guide explains how to check cluster availability by region using the Vultr API.

1. Send a GET request to the Get Cluster Availability endpoint to check available cluster types. This endpoint reads region and type from the request body for a GET request, not from query parameters. Replace REGION with the region identifier, such as ewr, ord, or lax. Set type to vps for a Compute Cluster, bare-metal for a Bare Metal Cluster, or gpu-fabric for a GPU Fabric Cluster. Omit the type, or set it to a value the API does not recognize, to get all types back unfiltered.

   CONSOLE

   Copy

   $ curl "https://api.vultr.com/v2/clusters/availability" \
       -X GET \
       -H "Authorization: Bearer ${VULTR_API_KEY}" \
       -H "Content-Type: application/json" \
       -d '{
           "region": "REGION",
           "type": "vps"
       }'

   Explain Code

   Powered by Vultr AgentBeta

   The response contains the available cluster types and plans for the specified region.

2. To check which regions support a specific plan instead, send a GET request to the same endpoint with the plan ID in the path. Replace {plan-id} with the plan's ID.

   CONSOLE

   Copy

   $ curl "https://api.vultr.com/v2/clusters/availability/{plan-id}" \
       -X GET \
       -H "Authorization: Bearer ${VULTR_API_KEY}"

   Explain Code

   Powered by Vultr AgentBeta

   Its response is not nested under an availability key.