How to Retrieve a Cluster

Retrieving a cluster returns its full details including the label, region, type, pool configuration, attached instances, instance template, and current status. This is useful for checking cluster health, reviewing configuration, and obtaining instance IDs for management operations.

This guide explains how to retrieve a cluster using the Vultr API.

1. Send a GET request to the List Clusters endpoint to retrieve all clusters.

   CONSOLE

   Copy

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

   Explain Code

   Powered by Vultr AgentBeta

   Note the id of the cluster you want to retrieve.

2. Send a GET request to the Get Cluster endpoint to retrieve the cluster details. Replace {cluster-id} with the id of the cluster.

   CONSOLE

   Copy

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

   Explain Code

   Powered by Vultr AgentBeta

   The response contains the cluster details including attached instances and current status.