v1

latestSwagger 2.02026-08-04232286653.5 KB
Kubernetes Clusters

Lists all Kubernetes clusters in the project and returns their details.

get/projects/{project_id}/kubernetes/clusters

Path parameters

project_idstring required

ID of the project that owns the clusters.

Query parameters

cluster_idstring

Filters results to the cluster with this ID.

cluster_namestring

Filters results to the cluster with this name.

cluster_search_namesstring[]

Filters results to clusters whose name matches one of these search names.

locationsstring[]

Filters results to clusters in these locations.

statesstring[]

Filters results to clusters in these states.

versionsstring[]

Filters results to clusters running these versions.

sortstring

Field to sort results by; prefix with '-' for descending order.

show_inactiveboolean

Whether to include inactive clusters in the results.

next_tokenstring

Base64-encoded token for the next page of results.

prev_tokenstring

Base64-encoded token for the previous page of results.

Response

Example response

{
  "items": [
    {
      "add_ons": [
        "crusoe_csi"
      ],
      "apiserver_extra_args": {
        "audit-log-maxage": "30"
      },
      "auth_config": {
        "oidc": {
          "client_id": "kubernetes",
          "groups_claim": "groups",
          "issuer_url": "https://oauth2.example.com",
          "username_claim": "email",
          "username_prefix": "oidc:"
        }
      },
      "cluster_cidr": "10.233.0.0/18",
      "configuration": "ha",
      "controller_manager_extra_args": {
        "bind-address": "0.0.0.0"
      },
      "created_at": "2021-12-03T19:58:34Z",
      "dns_name": "my-kubernetes-cluster.crusoecloudcompute.com",
      "id": "ab4a6b00-aa5f-408e-a9fb-ac6de5eb45ab",
      "kubelogin_args": {
        "force-refresh": "",
        "oidc-extra-scope": "email groups"
      },
      "location": "us-northcentral1-a",
      "name": "my-kubernetes-cluster",
      "node_cidr_mask_size": 24,
      "node_pools": [
        "1d2b3a4c-5e6f-7b9d-8c9a-0e1f2d3b4c5d"
      ],
      "private": true,
      "project_id": "9c8b7d6e-5f4a-3b2c-1e0f-2a3b4c5d6e7f",
      "scheduler_extra_args": {
        "bind-address": "0.0.0.0"
      },
      "service_cluster_ip_range": "10.233.0.0/18",
      "state": "STATE_RUNNING",
      "subnet_id": "09ae8411-0fbb-411c-898c-2b8f19622ae1",
      "updated_at": "2021-12-03T19:58:34Z",
      "version": "1.29.5-crusoe.0"
    }
  ]
}