v1

latestOpenAPI 3.0.0Apache 2.02026-07-17143274803.9 KB
clusters

List clusters

Listing all the K8S clusters from the cloud

get/api/v1/orgs/{orgId}/clusters

Path parameters

orgIdinteger required

Organization identifier

Response

All cluster listed

statusstring
statusMessagestring
namestring
cloudstring
distributionstring
versionstring
spotboolean
locationstring
idinteger
loggingboolean
monitoringboolean
securityscanboolean
createdAtstring
startedAtstring
creatorNamestring
creatorIdinteger
regionstring
nodePoolsobject

Example response

[
  {
    "securityscan": false,
    "creatorName": "userName",
    "creatorId": 1,
    "startedAt": "2018-07-03T14:23:29+02:00",
    "distribution": "gke",
    "monitoring": false,
    "version": "1.12.6-gke.10",
    "oidc": {
      "clientId": "clientId",
      "idpUrl": "idpUrl",
      "clientSecret": "clientSecret",
      "enabled": true
    },
    "statusMessage": "Cluster is running",
    "cloud": "google",
    "createdAt": "2018-07-03T14:23:19+02:00",
    "spot": false,
    "name": "myClusterName",
    "logging": false,
    "totalSummary": {
      "memory": {
        "allocatable": "4",
        "request": "380m",
        "limit": "100m",
        "capacity": "4"
      },
      "cpu": {
        "allocatable": "4",
        "request": "380m",
        "limit": "100m",
        "capacity": "4"
      },
      "status": "status"
    },
    "location": "us-central1-a",
    "id": 1,
    "nodePools": {
      "key": {
        "count": 1,
        "instanceType": "n1-standard-1"
      }
    },
    "region": "us-central1",
    "status": "RUNNING"
  }
]