SOsotoon
Sotoon Kubernetes Engine

List Clusters

Retrieves a paginated list of all Kubernetes clusters in the specified workspace

get/ske/v2alpha1/thr1-standard/workspaces/{workspaceUUID}/sotoonclusters

Request

  • Base URL
    https://api.sotoon.ir (the document declares no server; this is the origin it was published from)
  • Auth
    HTTP bearer

Path parameters

workspaceUUIDstring required

UUID of the workspace

Response

Successfully retrieved the list of Kubernetes clusters. The response includes details about each cluster such as its configuration, status, metadata, name, creation time, specs, and current status.

apiVersionstring required

Version identifier of the API schema

kind'SotoonClusterList' required

The string value 'SotoonClusterList'

Example response

{
  "items": [
    {
      "apiVersion": "ske.sotoon.ir/v1alpha1",
      "kind": "SotoonCluster",
      "metadata": {
        "resourceVersion": "12345",
        "uid": "550e8400-e29b-41d4-a716-446655440000",
        "workspace": "550e8400-e29b-41d4-a716-446655440000"
      },
      "spec": {
        "infra": {
          "VPC": "default",
          "subnet": "default",
          "version": {
            "kubernetesVersion": "v1.28.4",
            "patchVersion": "ske-1.0.2"
          }
        }
      },
      "status": {
        "kubeconfigSecretName": {
          "name": "my-cluster-kubeconfig"
        },
        "phase": "Ready"
      }
    }
  ],
  "kind": "SotoonClusterList"
}

Changes

No recorded changes to this operation across all 6 revisions of this API.