GET /sks-cluster/{id}

Path parameters

  • id string(uuid) Required

Responses

  • 200 application/json

    200

    Hide response attributes Show response attributes object
    • description string

      Cluster description

      Maximum length is 255.

    • labels object
      Hide labels attribute Show labels attribute object
      • * string Additional properties
    • cni string

      Cluster CNI

      Values are calico or cilium.

    • auto-upgrade boolean

      Enable auto upgrade of the control plane to the latest patch version available

    • name string

      Cluster name

      Minimum length is 1, maximum length is 255.

    • enable-operators-ca boolean

      Indicates whether to add operators certificate authority (CA) as part of trusted CAs for the API server.

    • state string

      Cluster state

      Values are rotating-csi-credentials, rotating-ccm-credentials, creating, upgrading, deleting, running, suspending, updating, error, rotating-karpenter-credentials, or resuming.

    • enable-kube-proxy boolean

      Indicates whether to deploy the Kubernetes network proxy.

    • nodepools array[object]

      Cluster Nodepools

      SKS Nodepool

      Not more than 16 elements.

      Hide nodepools attributes Show nodepools attributes object
      • anti-affinity-groups array[object]

        Nodepool Anti-affinity Groups

        Anti-affinity group reference

        Not more than 8 elements.

        Hide anti-affinity-groups attribute Show anti-affinity-groups attribute object
        • id string(uuid)

          Anti-affinity group ID

      • description string

        Nodepool description

        Maximum length is 255.

      • public-ip-assignment string

        Nodepool public IP assignment of the Instances:

        • IPv4 (inet4) addressing only;
        • IPv4 and IPv6 (dual) addressing.

        Values are inet4 or dual.

      • labels object
        Hide labels attribute Show labels attribute object
        • * string Additional properties
      • taints object
        Hide taints attribute Show taints attribute object
        • * object Additional properties

          Nodepool taint

          Hide * attributes Show * attributes object
          • value string Required

            Nodepool taint value

            Minimum length is 1, maximum length is 255.

          • effect string Required

            Nodepool taint effect

            Values are NoExecute, NoSchedule, or PreferNoSchedule.

      • security-groups array[object]

        Nodepool Security Groups

        Security group reference

        Not more than 16 elements.

        Hide security-groups attribute Show security-groups attribute object
        • id string(uuid)

          Security group ID

      • name string

        Nodepool name

        Minimum length is 1, maximum length is 255.

      • instance-type object

        Instance type reference

        Hide instance-type attribute Show instance-type attribute object
        • id string(uuid)

          Instance type ID

      • private-networks array[object]

        Nodepool Private Networks

        Private network reference

        Not more than 16 elements.

        Hide private-networks attribute Show private-networks attribute object
        • id string(uuid)

          Private network ID

      • template object

        Template reference

        Hide template attribute Show template attribute object
        • id string(uuid)

          Template ID

      • state string

        Nodepool state

        Values are renewing-token, creating, deleting, running, scaling, updating, or error.

      • size integer(int64)

        Number of instances

        Minimum value is 0.

      • kubelet-image-gc object

        Kubelet image GC options

        Hide kubelet-image-gc attributes Show kubelet-image-gc attributes object
        • high-threshold integer(int64)

          Minimum value is 0.

        • low-threshold integer(int64)

          Minimum value is 0.

        • min-age string
      • instance-pool object

        Target Instance Pool

        Hide instance-pool attribute Show instance-pool attribute object
        • id string(uuid)

          Instance Pool ID

      • instance-prefix string

        The instances created by the Nodepool will be prefixed with this value (default: pool)

        Minimum length is 1, maximum length is 30.

      • deploy-target object

        Deploy target reference

        Hide deploy-target attribute Show deploy-target attribute object
        • id string(uuid)

          Deploy target ID

      • addons array[string]

        Nodepool addons

        Value is storage-lvm.

      • id string(uuid)

        Nodepool ID

      • disk-size integer(int64)

        Nodepool instances disk size in GiB

        Minimum value is 20, maximum value is 51200.

      • version string

        Nodepool version

      • created-at string(date-time)

        Nodepool creation date

    • level string

      Cluster level

      Values are starter or pro.

    • feature-gates array[string]

      A list of Kubernetes-only Alpha features to enable for API server component

    • addons array[string]

      Cluster addons

      Values are exoscale-cloud-controller, exoscale-container-storage-interface, metrics-server, or karpenter.

    • id string(uuid)

      Cluster ID

    • audit object

      Kubernetes Audit parameters

      Hide audit attributes Show audit attributes object
      • endpoint string

        Minimum length is 1, maximum length is 2000.

      • enabled boolean

        Enabled

      • initial-backoff string

        Minimum length is 1, maximum length is 10.

    • version string

      Control plane Kubernetes version

    • created-at string(date-time)

      Cluster creation date

    • endpoint string

      Cluster endpoint

GET /sks-cluster/{id}
curl \
 --request GET 'https://api-ch-gva-2.exoscale.com/v2/sks-cluster/{id}'
Response examples (200)
{
  "description": "string",
  "labels": {
    "additionalProperty1": "string",
    "additionalProperty2": "string"
  },
  "cni": "calico",
  "auto-upgrade": true,
  "name": "string",
  "enable-operators-ca": true,
  "state": "rotating-csi-credentials",
  "enable-kube-proxy": true,
  "nodepools": [
    {
      "anti-affinity-groups": [
        {
          "id": "string"
        }
      ],
      "description": "string",
      "public-ip-assignment": "inet4",
      "labels": {
        "additionalProperty1": "string",
        "additionalProperty2": "string"
      },
      "taints": {
        "additionalProperty1": {
          "value": "string",
          "effect": "NoExecute"
        },
        "additionalProperty2": {
          "value": "string",
          "effect": "NoExecute"
        }
      },
      "security-groups": [
        {
          "id": "string"
        }
      ],
      "name": "string",
      "instance-type": {
        "id": "string"
      },
      "private-networks": [
        {
          "id": "string"
        }
      ],
      "template": {
        "id": "string"
      },
      "state": "renewing-token",
      "size": 42,
      "kubelet-image-gc": {
        "high-threshold": 42,
        "low-threshold": 42,
        "min-age": "string"
      },
      "instance-pool": {
        "id": "string"
      },
      "instance-prefix": "string",
      "deploy-target": {
        "id": "string"
      },
      "addons": [
        "storage-lvm"
      ],
      "id": "string",
      "disk-size": 42,
      "version": "string",
      "created-at": "2026-05-04T09:42:00Z"
    }
  ],
  "level": "starter",
  "feature-gates": [
    "string"
  ],
  "addons": [
    "exoscale-cloud-controller"
  ],
  "id": "string",
  "audit": {
    "endpoint": "string",
    "enabled": true,
    "initial-backoff": "string"
  },
  "version": "string",
  "created-at": "2026-05-04T09:42:00Z",
  "endpoint": "string"
}