Sotoon Kubernetes Engine

Get Cluster

Retrieves detailed information about a specific Kubernetes cluster by cluster name

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

Request

Base URL
https://api.sotoon.ir (the document declares no server; this is the origin it was published from)
Auth
HTTP bearer
TypeScript
https://skmtc.dev/sotoon/apis/sotoon-api/docs/ske/v2alpha1/thr1-standard/workspaces/:workspaceUUID/sotoonclusters/:resourceId/get.ts
A function with typed inputs. Its response is checked against the schema.

Path parameters

resourceIdstring required

Resource ID

workspaceUUIDstring required

UUID of the workspace

Response

Successfully retrieved the details of the specified Kubernetes cluster in the workspace.

apiVersion'ske.sotoon.ir/v1alpha1' required

Version identifier of the API schema

kind'SotoonCluster' required

The string value 'SotoonCluster' that identifies the schema

Example response

{
  "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"
  }
}

Changes

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