List clusters

GET

https://nvke.acme.example/api/clusters

GET

/api/clusters

curl https://nvke.acme.example/api/clusters \
     -H "Authorization: Bearer <token>" \
     -H "Content-Type: application/json"

{
  "clusters": [
    {
      "id": "a3f1c2d4-5e6b-7890-abcd-ef1234567890",
      "name": "tenant-a-prod",
      "controlPlaneKubernetesVersion": "1.29.3",
      "cniPlugin": "ovn-kubernetes",
      "cniVersion": "2.4.2",
      "etcdEncrypted": true,
      "network": {
        "podCIDR": "192.168.0.0/16",
        "serviceCIDR": "10.96.0.0/12"
      },
      "createdAt": "2024-01-15T09:30:00Z",
      "conditions": {
        "provisioning": {
          "status": "False",
          "lastTransitionTime": "2024-01-15T09:45:00Z",
          "message": "Cluster provisioning completed successfully"
        },
        "provisioned": {
          "status": "True",
          "lastTransitionTime": "2024-01-15T09:45:00Z",
          "message": "All control-plane nodes are ready"
        },
        "deleting": {
          "status": "False",
          "lastTransitionTime": "2024-01-15T09:30:00Z",
          "message": ""
        },
        "cpNodesRecycling": {
          "status": "False",
          "lastTransitionTime": "2024-01-15T09:45:00Z",
          "message": ""
        },
        "controlPlaneUpgrading": {
          "status": "False",
          "lastTransitionTime": "2024-01-15T09:45:00Z",
          "message": ""
        },
        "updateInProgress": {
          "type": "k8s_upgrade",
          "startedAt": "2024-03-20T14:00:00Z",
          "message": "Upgrading control plane from 1.28.7 to 1.29.3"
        },
        "updateFailed": {
          "status": "False",
          "lastTransitionTime": "2024-01-15T09:45:00Z",
          "message": ""
        }
      },
      "controlPlaneVIP": "10.10.0.50",
      "enableCPNodeRecycling": false,
      "controlPlaneConfig": {
        "configurationId": "b7e2d1a0-3c4f-4e8a-9b12-cd5678901234",
        "desiredCount": 3,
        "maxSurge": 1,
        "provisioningMonitorDisabled": false,
        "systemReservedMemory": "16Gi",
        "machineAnnotations": {},
        "machineLabels": {},
        "nodeLabels": {},
        "nico": {
          "instanceTypePreference": [
            "c1d2e3f4-a5b6-7890-abcd-111122223333"
          ],
          "subnetIDs": [
            "d4e5f6a7-b8c9-0123-def0-444455556666"
          ],
          "vpcPrefixIDs": [
            "e7f8a9b0-c1d2-3456-ef01-777788889999"
          ],
          "release": "example-ubuntu-24.04-amd64",
          "diskSelectionStrategy": "smallest",
          "sshKeyGroupIDs": [
            "f0a1b2c3-d4e5-6789-f012-aaaabbbbcccc"
          ]
        },
        "launchLayer": {
          "instanceType": "vm200",
          "hostOSProfile": "ubuntu-24.04-amd64",
          "vmProfile": "standard-vm:1.2.0",
          "fulfillmentStrategy": "BEST_EFFORT",
          "securityGroupRefs": {
            "primaryNetworkInterface": [
              "cp-primary-sg"
            ],
            "gpuNetworkInterface": [
              "cp-gpu-sg"
            ]
          }
        },
        "nodeAgentConfig": {
          "version": "1.5.2"
        }
      },
      "nico": {
        "orgID": "dipfedrcvjiw",
        "siteID": "11223344-5566-7788-99aa-bbccddeeff00",
        "vpcID": "aabbccdd-eeff-0011-2233-445566778899"
      },
      "launchLayer": {
        "siteID": "datahall-us-west-1",
        "vpcID": "vpc-0a1b2c3d4e5f67890",
        "orgID": "org-acme-infra",
        "vpcType": "BARE_METAL",
        "cloudProviderEnabled": false,
        "owner": {
          "userID": "usr-7f8e9d0c1b2a3456",
          "username": "platform-admin"
        },
        "securityGroups": [
          {
            "name": "cp-primary-sg",
            "type": "BARE_METAL",
            "networkType": "primary"
          }
        ]
      },
      "nodeAgentUpgrade": {
        "nodeId": "cc112233-4455-6677-8899-aabbccddeeff",
        "targetVersion": "1.5.2",
        "method": "apt",
        "phase": "Running",
        "errorMessage": "connection timeout on attempt 2, retrying"
      }
    }
  ]
}

Returns all clusters, or the cluster whose name matches name.

Authentication

AuthorizationBearer

A JWT from an issuer the Operator has configured, carried as Authorization: Bearer <token>.

Query parameters

namestringOptional

Filter clusters by name (exact match)

Response

A list of clusters

clusterslist of objects

Clusters.

Errors

401

Unauthorized Error

403

Forbidden Error