List Clusters

GET

/clusters

const url = 'https://api.mengi.cloud/clusters';
const options = {method: 'GET'};

try {
  const response = await fetch(url, options);
  const data = await response.json();
  console.log(data);
} catch (error) {
  console.error(error);
}

curl --request GET \
  --url https://api.mengi.cloud/clusters

List all clusters for the current user (excludes management and host clusters).

For shared tier clusters (vClusters), fetches real-time status from ArgoCD to ensure the UI always reflects the actual cluster state.

Responses

200

Successful Response

application/json

ClusterListResponse

object

clusters

required

Clusters

Array<object>

ClusterResponse

object

required

string format: uuid

name

required

Name

string

provider

required

Provider

string

region

required

Region

string

tier

required

ClusterTier

string

Allowed values: shared testing production

status

required

ClusterStatus

string

Allowed values: pending provisioning importing running upgrading error deleting

kubernetes_version

Any of:

string
null

string

server_type

Any of:

string
null

string

argocd_url

Any of:

string
null

string

git_repo_url

Any of:

string
null

string

error_message

Any of:

string
null

string

status_message

Any of:

string
null

string

created_at

required

Created At

string format: date-time

updated_at

required

Updated At

string format: date-time

provisioning_started_at

Any of:

string
null

string format: date-time

provisioning_completed_at

Any of:

string
null

string format: date-time

autoscaling_enabled

Autoscaling Enabled

boolean

min_nodes

Any of:

integer
null

integer

max_nodes

Any of:

integer
null

integer

target_kubernetes_version

Any of:

string
null

string

upgrade_available

Upgrade Available

boolean

upgrade_available_version

Any of:

string
null

string

scheduled_upgrade_date

Any of:

string
null

string format: date-time

scheduled_upgrade_id

Any of:

string
null

string format: uuid

component_bundle_version

Component Bundle Version

string

default: latest

multi_region

Multi Region

boolean

region_locations

Any of:

Array<string>
null

Array<string>

is_byoc

Is Byoc

boolean

cloud_credential_id

Any of:

string
null

string format: uuid

is_imported

Is Imported

boolean

is_autopilot

Is Autopilot

boolean

display_order

Any of:

integer
null

integer

total

required

Total

integer

Example

{
  "clusters": [
    {
      "tier": "shared",
      "status": "pending",
      "autoscaling_enabled": false,
      "upgrade_available": false,
      "component_bundle_version": "latest",
      "multi_region": false,
      "is_byoc": false,
      "is_imported": false,
      "is_autopilot": false
    }
  ]
}