Get a list of clusters.

GET

http://localhost:8080/api/v1/clusters

GET

/api/v1/clusters

curl -G http://localhost:8080/api/v1/clusters \
     -H "Authorization: Bearer <token>" \
     -d includeRequestedForDelete=true \
     -d verbosity=full

[
  {
    "uuid": "string",
    "tenantId": 1001,
    "name": "string",
    "createdAt": "2024-01-15T09:30:00Z",
    "domain": "string",
    "version": "string",
    "status": {
      "conditions": [
        {
          "lastTransitionTime": "2024-01-15T09:30:00Z",
          "message": "string",
          "reason": "string",
          "status": "True",
          "type": "string",
          "observedGeneration": 1
        }
      ],
      "config": {
        "workloadOwnershipProtection": false,
        "subdomainEnabled": false,
        "ingressClass": "nginx",
        "ingressEnabled": true,
        "gatewayName": "my-gateway",
        "gatewayNamespace": "gateway-system",
        "gatewayAPIEnabled": false,
        "gitSyncImage": "gcr.io/runai/git-sync:v4.2.0",
        "gitSyncResources": {
          "limits": {
            "cpu": "100m",
            "memory": "128Mi"
          },
          "requests": {
            "cpu": "100m",
            "memory": "128Mi"
          }
        },
        "s3FileSystemImage": "gcr.io/runai/goofys:v0.24.0",
        "s3FileSystemResources": {
          "limits": {
            "cpu": "100m",
            "memory": "128Mi"
          },
          "requests": {
            "cpu": "100m",
            "memory": "128Mi"
          }
        },
        "fipsMode": "only",
        "runaiOauth2ProxyImage": "gcr.io/runai/oauth2-proxy:v7.5.1",
        "runaiOauth2ProxyResources": {
          "limits": {
            "cpu": "100m",
            "memory": "128Mi"
          },
          "requests": {
            "cpu": "100m",
            "memory": "128Mi"
          }
        },
        "runaiOauth2ProxyUsernameLoaderImage": "gcr.io/runai/oauth2-proxy-username-loader:v1.0.0",
        "usernameLoaderResources": {
          "limits": {
            "cpu": "100m",
            "memory": "128Mi"
          },
          "requests": {
            "cpu": "100m",
            "memory": "128Mi"
          }
        },
        "runaiOauth2ProxyRedisFQDN": "cluster-redis.runai.svc.cluster.local:6379",
        "runaiOauth2ProxyWorkloadAuthSecretName": "runai-workload-auth",
        "runaiOauth2ProxySessionStoreType": "cookie",
        "runaiOauth2ProxyOidcIssuerUrl": "http://localhost:8080/auth/realms/runai",
        "customCAGit": {
          "enabled": true,
          "secretName": "runai-ca",
          "secretKey": "runai-ca.pem",
          "optional": false
        },
        "customCAS3": {
          "enabled": true,
          "secretName": "runai-ca",
          "secretKey": "runai-ca.pem",
          "optional": false
        },
        "customCAOauth2Proxy": {
          "enabled": true,
          "secretName": "runai-ca",
          "secretKey": "runai-ca.pem",
          "optional": false
        },
        "externalAuthUrlEnabled": true,
        "openshiftRouteTerminationPolicy": "edge",
        "distGPUNetworkAcceleration": false,
        "dinfGPUNetworkAcceleration": false
      },
      "dependencies": {
        "required": {},
        "optional": {}
      },
      "operands": {},
      "platform": {
        "type": "vanilla",
        "kubeVersion": "string"
      },
      "state": "WaitingToConnect"
    },
    "updatedAt": "2024-01-15T09:30:00Z",
    "deletedAt": "2024-01-15T09:30:00Z",
    "lastLiveness": "2024-01-15T09:30:00Z",
    "deleteRequestedAt": "2024-01-15T09:30:00Z"
  }
]

Retrieve a list of clusters with details.

Authentication

AuthorizationBearer

Bearer authentication

Query parameters

verbosityenumOptionalDefaults to full

response verbosity level.

Allowed values:

includeRequestedForDeletebooleanOptional

When true, includes clusters that are marked for deletion

Response

Executed successfully.

uuidstringformat: "uuid"

tenantIdinteger

The id of the tenant.

namestring1-253 characters

createdAtdatetime

domainstring or nullOptional1-253 characters

versionstring or nullOptional1-50 characters

statusobjectOptional

The cluster's displayed status.

updatedAtdatetime or nullOptional

deletedAtdatetime or nullOptional

lastLivenessdatetime or nullOptional

deleteRequestedAtdatetime or nullOptional

the timestamp value of when the cluster deletion request was received

Errors

401

Unauthorized Error

403

Forbidden Error

404

Not Found Error

500

Internal Server Error

503

Service Unavailable Error