Skip to main content
GET
/clusters/{id}/info

Authorizations

X-API-KEY
string
header
required

Path Parameters

id
string
required

The cluster id

Response

200 - application/json

Return a cluster object.

id
string<uuid>
required

The unique identifier for the cluster.

Example:

"8eda86fe-0f36-41ed-9837-0ccf8f6e0fcb"

cloud
string
required

The cloud provider for the cluster.

Example:

"denvr"

name
string
required

The name of the cluster.

Example:

"devnr-cluster1"

region_info
object
required
status
string
required

The current status of the cluster.

Example:

"active"

created_at
string<date-time>
required

The timestamp when the cluster was created.

updated_at
string<date-time>
required

The timestamp when the cluster was last updated.

instances
object[]
required

Array of instances in the cluster.

hourly_price
integer
required

The hourly price of the cluster in cents.

Example:

1500

cloud_cluster_id
string | null

The cloud provider assigned cluster ID.

Example:

"cluster-abc123"

status_details
string | null

Additional details about the cluster status.

Example:

"Cluster is provisioning"

cost_estimate
string | null

Estimated cost of the cluster.

Example:

"$15.00"

active_at
string<date-time> | null

The timestamp when the cluster became active.