Latest Content

How to Retrieve a Cluster

Updated on 21 April, 2026

Retrieve full details of a Vultr cluster including its label, region, type, pool configuration, attached instances, and current status via the API.

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 
    $ curl "https://api.vultr.com/v2/clusters" \
    -X GET \
    -H "Authorization: Bearer ${VULTR_API_KEY}"

    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 
    $ curl "https://api.vultr.com/v2/clusters/{cluster-id}" \
    -X GET \
    -H "Authorization: Bearer ${VULTR_API_KEY}"

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

Comments