Skip to main content
GET
Get a cluster

Authorizations

Authorization
string
header
required

Bearer authentication header of the form Bearer <token>, where <token> is your auth token.

Path Parameters

organizationId
string
required

The ID of the Organization to which the cluster belongs.

clusterId
string
required

The cluster's ID.

Response

OK

cloudProvider
enum<string>
required

The name of the cluster's cloud provider.

Available options:
AWS,
AZURE,
GCP
Example:

"AWS"

createdAt
string<date-time>
required

The time when the cluster was created in UTC. formatted as YYYY-MM-DDTHH:MM:SSZ.

Example:

"2022-11-22T04:37:12Z"

dbInstanceType
string
required

The type of database instance that is used for the cluster.

Example:

"db.t3.medium"

drRegion
string
required

The secondary region for Disaster Recovery for the cluster.

Example:

"us-east-1"

id
string
required

The cluster's ID.

Example:

"clm7k8tgw000008jz97i37y81"

isDrEnabled
boolean
required

Whether Disaster Recovery is enabled on the cluster

name
string
required

The cluster's name.

Example:

"my cluster"

organizationId
string
required

The ID of the Organization that the cluster belongs to.

Example:

"clm88r8hi000008jwhzxu5crg"

region
string
required

The region in which the cluster is created.

Example:

"us-east-1"

status
enum<string>
required

The status of the cluster.

Available options:
CREATING,
CREATED,
CREATE_FAILED,
UPDATE_FAILED,
UPDATING,
ACCESS_DENIED,
UPGRADE_PENDING,
FAILING_OVER,
FAILOVER_FAILED
Example:

"CREATED"

type
enum<string>
required

The type of the cluster.

Available options:
DEDICATED,
HYBRID
Example:

"DEDICATED"

updatedAt
string<date-time>
required

The time when the cluster was last updated in UTC. formatted as YYYY-MM-DDTHH:MM:SSZ.

Example:

"2022-11-22T04:37:12Z"

vpcSubnetRange
string
required

The VPC subnet range.

Example:

"172.20.0.0/22"

drPodSubnetRange
string

The disaster recovery subnet range for Pods. For GCP clusters only.

Example:

"172.21.0.0/19"

drSecondaryVpcCidr
string

The secondary CIDR for the DR region. For AWS clusters only.

drServicePeeringRange
string

The disaster recovery service peering range. For GCP clusters only.

Example:

"172.23.0.0/20"

drServiceSubnetRange
string

The disaster recovery service subnet range. For GCP clusters only.

Example:

"172.22.0.0/22"

drVpcSubnetRange
string

The VPC subnet range for the DR region.

enableReplicationTimeControl
boolean

Whether Bucket Storage Replication Time Control is enabled for DR.

failoverInProgress
boolean

Whether a failover is currently in progress.

healthStatus
object
isFailedOver
boolean

Whether the cluster is currently failed over to the DR region.

isLimited
boolean

Whether the cluster is limited.

Example:

false

isPrivateNetworkEgressEnabled
boolean

Whether Private Network Egress mode is enabled, which disables public Internet connectivity from the cluster's Deployments and metrics exports. For AWS clusters only.

metadata
object
nodePools
object[]

The list of node pools that are created in the cluster.

podSubnetRange
string

The subnet range for Pods. For GCP clusters only.

Example:

"172.21.0.0/19"

providerAccount
string

The provider account ID. For GCP clusters only.

Example:

"provider-account"

secondaryVpcCidr
string

The secondary VPC CIDR. For AWS clusters only.

servicePeeringRange
string

The service peering range. For GCP clusters only.

Example:

"172.23.0.0/20"

serviceSubnetRange
string

The service subnet range. For GCP clusters only.

Example:

"172.22.0.0/22"

tags
object[]

The Kubernetes tags in the cluster. For AWS Hybrid clusters only.

tenantId
string

The tenant ID. For Azure clusters only.

Example:

"your-tenant-id"

workspaceIds
string[]

The list of Workspaces that are authorized to the cluster.

Example: