--- title: "List SKS clusters" method: GET path: "/sks-cluster" tags: ["cluster"] --- # List SKS clusters `GET /sks-cluster` ## Request - Base URL: `https://api-ch-gva-2.exoscale.com/v2` - URL: `https://api-ch-gva-2.exoscale.com/v2/sks-cluster` - Auth: none declared - TypeScript: (a function with typed inputs; its response is checked against the schema) ## Response `200` 200 - object - `sks-clusters` SksCluster[] - `description` string: Cluster description - `labels` SksClusterLabels - `cni` 'calico' | 'cilium': Cluster CNI - `auto-upgrade` boolean: Enable auto upgrade of the control plane to the latest patch version available - `oidc` SksOidc: SKS Cluster OpenID config map - `client-id` string, required: OpenID client ID - `issuer-url` string, required: OpenID provider URL - `username-claim` string: JWT claim to use as the user name - `username-prefix` string: Prefix prepended to username claims - `groups-claim` string: JWT claim to use as the user's group - `groups-prefix` string: Prefix prepended to group claims - `required-claim` object: A key value map that describes a required claim in the ID Token - `name` string: Cluster name - `enable-operators-ca` boolean: Indicates whether to add operators certificate authority (CA) as part of trusted CAs for the API server. - `default-security-group-id` string, uuid, nullable: Cluster default Security Group ID - `state` 'rotating-csi-credentials' | 'rotating-ccm-credentials' | 'creating' | 'upgrading' | 'deleting' | 'running' | 'suspending' | 'updating' | 'error' | 'rotating-karpenter-credentials' | 'resuming': Cluster state - `enable-kube-proxy` boolean: Indicates whether to deploy the Kubernetes network proxy. - `nodepools` SksNodepool[]: Cluster Nodepools - `anti-affinity-groups` AntiAffinityGroupRef[]: Nodepool Anti-affinity Groups - `id` string, uuid: Anti-affinity group ID - `description` string: Nodepool description - `public-ip-assignment` 'inet4' | 'dual': Nodepool public IP assignment of the Instances: * IPv4 (`inet4`) addressing only; * IPv4 and IPv6 (`dual`) addressing. - `labels` SksNodepoolLabels - `taints` SksNodepoolTaints - `security-groups` SecurityGroupRef[]: Nodepool Security Groups - `id` string, uuid: Security group ID - `name` string: Nodepool name - `instance-type` InstanceTypeRef: Instance type reference - `id` string, uuid: Instance type ID - `private-networks` PrivateNetworkRef[]: Nodepool Private Networks - `id` string, uuid: Private network ID - `template` TemplateRef: Template reference - `id` string, uuid: Template ID - `state` 'renewing-token' | 'creating' | 'deleting' | 'running' | 'degraded' | 'scaling' | 'updating' | 'error': Nodepool state - `size` integer: Number of instances - `kubelet-image-gc` KubeletImageGc: Kubelet image GC options - `high-threshold` integer - `low-threshold` integer - `min-age` string - `instance-pool` InstancePoolRef: Target Instance Pool - `id` string, uuid: Instance Pool ID - `instance-prefix` string: The instances created by the Nodepool will be prefixed with this value (default: pool) - `deploy-target` DeployTargetRef: Deploy target reference - `id` string, uuid: Deploy target ID - `addons` string[]: Nodepool addons - `id` string, uuid: Nodepool ID - `disk-size` integer: Nodepool instances disk size in GiB - `version` string: Nodepool version - `nvidia-mig-profiles` NvidiaMigProfiles: Nvidia MIG Profiles enabled - `a30.24gb` '1g.6gb' | '1g.6gb+me' | '2g.12gb' | '2g.12gb+me' | '4g.24gb' - `rtxpro6000.96gb` '1g.24gb' | '1g.24gb+me' | '1g.24gb+gfx' | '1g.24gb+me.all' | '1g.24gb-me' | '2g.48gb' | '2g.48gb+gfx' | '2g.48gb+me.all' | '2g.48gb-me' | '4g.96gb' | '4g.96gb+gfx' - `b300.269gb` '1g.34gb' | '1g.34gb+me' | '1g.67gb' | '2g.67gb' | '3g.135gb' | '4g.135gb' | '7g.269gb' - `created-at` string, date-time: Nodepool creation date - `level` 'starter' | 'pro': Cluster level - `feature-gates` string[]: A list of Kubernetes-only Alpha features to enable for API server component - `addons` string[]: Cluster addons - `id` string, uuid: Cluster ID - `audit` SksAudit: Kubernetes Audit parameters - `endpoint` string - `enabled` boolean: Enabled - `initial-backoff` string - `version` string: Control plane Kubernetes version - `created-at` string, date-time: Cluster creation date - `endpoint` string: Cluster endpoint ## Changes - **2026-11-06** `63da6f74c845`: 1 warning, 3 info - added the new `degraded` enum value to the `sks-clusters/items/nodepools/items/state` response property for the response status `200` - added the optional property `sks-clusters/items/default-security-group-id` to the response with the `200` status - added the optional property `sks-clusters/items/nodepools/items/nvidia-mig-profiles` to the response with the `200` status - added the optional property `sks-clusters/items/oidc` to the response with the `200` status - **2026-03-16** `e05707a7b346`: 1 breaking, 63 warning, 9 info - the response property `sks-clusters/items/nodepools/items/deploy-target/id` became optional for the status `200` - removed the optional property `sks-clusters/items/nodepools/items/anti-affinity-groups/items/description` from the response with the `200` status - removed the optional property `sks-clusters/items/nodepools/items/anti-affinity-groups/items/instances` from the response with the `200` status - removed the optional property `sks-clusters/items/nodepools/items/anti-affinity-groups/items/name` from the response with the `200` status - …69 more - …earlier changes not shown [Operation history](https://skmtc.dev/exoscale/apis/exoscale-api/changes/sks-cluster/get.md) --- [API](https://skmtc.dev/exoscale/apis/exoscale-api.md) - [All operations](https://skmtc.dev/exoscale/apis/exoscale-api/llms.txt) - [OpenAPI document](https://skmtc.dev/exoscale/apis/exoscale-api/revisions/63da6f74c845?raw)