List SKS clusters

GET /sks-cluster

Responses

  • 200 application/json

    200

    Hide response attribute Show response attribute object
    • sks-clusters array[object]
      Hide sks-clusters attributes Show sks-clusters attributes object
      • Cluster description

        Maximum length is 255.

      • labels object

        Resource labels

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

        Cluster CNI

        Values are calico or cilium.

      • 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.

      • state string

        Cluster state

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

      • nodepools array[object]

        Cluster Nodepools

        Hide nodepools attributes Show nodepools attributes object
        • Nodepool Anti-affinity Groups

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

            Anti-affinity Group ID

          • name string

            Anti-affinity Group name

            Minimum length is 1, maximum length is 255.

          • Anti-affinity Group description

            Maximum length is 255.

          • instances array[object]

            Anti-affinity Group instances

            Hide instances attributes Show instances attributes object
            • Instance Anti-affinity Groups

              Anti-affinity Group

              Additional properties are allowed.

            • Instance public IP assignment

              Values are inet4, dual, or none.

            • labels object

              Resource labels

              Hide labels attribute Show labels attribute object
              • * string Additional properties
            • security-groups array[object]

              Instance Security Groups

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

                Security Group ID

              • name string

                Security Group name

                Minimum length is 1, maximum length is 255.

              • Security Group description

                Maximum length is 255.

              • external-sources array[string]

                Security Group external sources

            • elastic-ips array[object]

              Instance Elastic IPs

              Hide elastic-ips attributes Show elastic-ips attributes object
              • id string(uuid)

                Elastic IP ID

              • ip string

                Elastic IP address

              • Elastic IP address family

                Values are inet4 or inet6.

              • cidr string

                Elastic IP cidr

              • Elastic IP description

                Maximum length is 255.

              • Elastic IP healthcheck

                Additional properties are allowed.

                Hide healthcheck attributes Show healthcheck attributes object
                • strikes-ok integer(int64)

                  Number of attempts before considering the target healthy (default: 2)

                  Minimum value is 1, maximum value is 20.

                • Skip TLS verification

                • tls-sni string

                  An optional domain or subdomain to check TLS against

                  Minimum length is 1, maximum length is 255.

                • strikes-fail integer(int64)

                  Number of attempts before considering the target unhealthy (default: 3)

                  Minimum value is 1, maximum value is 20.

                • mode string Required

                  Health check mode

                  Values are tcp, http, or https.

                • port integer(int64) Required

                  Health check port

                  Minimum value is 1, maximum value is 65535.

                • uri string

                  An endpoint to use for the health check, for example '/status'

                  Minimum length is 1, maximum length is 255.

                • interval integer(int64)

                  Interval between the checks in seconds (default: 10)

                  Minimum value is 5, maximum value is 300.

                • timeout integer(int64)

                  Health check timeout value in seconds (default: 2)

                  Minimum value is 2, maximum value is 60.

              • labels object

                Resource labels

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

              Instance name

              Minimum length is 1, maximum length is 255.

            • Instance Type

              Additional properties are allowed.

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

                Instance type ID

              • size string

                Instance type size

                Values are large, huge, jumbo, medium, mega, small, extra-large, titan, micro, colossus, or tiny.

              • family string

                Instance type family

                Values are gpu3, gpu2, gpu, memory, storage, standard, colossus, or cpu.

              • cpus integer(int64)

                CPU count

                Minimum value is 0.

              • gpus integer(int64)

                GPU count

                Minimum value is 0.

              • authorized boolean

                Requires authorization or publicly available

              • memory integer(int64)

                Available memory

                Minimum value is 0.

              • zones array[string]

                Instance Type available zones

                Values are ch-dk-2, de-muc-1, ch-gva-2, at-vie-1, de-fra-1, bg-sof-1, or at-vie-2.

            • private-networks array[object]

              Instance Private Networks

              Hide private-networks attributes Show private-networks attributes object
            • template object

              Instance Template

              Additional properties are allowed.

              Hide template attributes Show template attributes object
              • Template maintainer

              • Template description

                Maximum length is 255.

              • Enable SSH key-based login

              • family string

                Template family

              • name string

                Template name

                Minimum length is 1, maximum length is 255.

              • Template default user

                Minimum length is 1, maximum length is 255.

              • size integer(int64)

                Template size

                Minimum value is 0.

              • Enable password-based login

              • build string

                Template build

              • checksum string

                Template MD5 checksum

              • Boot mode (default: legacy)

                Values are legacy or uefi.

              • id string(uuid)

                Template ID

              • zones array[string]

                Zones availability

                Values are ch-dk-2, de-muc-1, ch-gva-2, at-vie-1, de-fra-1, bg-sof-1, or at-vie-2.

              • url string

                Template source URL

              • version string

                Template version

              • created-at string(date-time)

                Template creation date

              • Template visibility

                Values are private or public.

            • state string

              Instance state

              Values are expunging, starting, destroying, running, stopping, stopped, migrating, error, or destroyed.

            • ssh-key object

              Instance SSH Key

              Additional properties are allowed.

              Hide ssh-key attributes Show ssh-key attributes object
              • name string

                SSH key name

                Minimum length is 1, maximum length is 255.

              • SSH key fingerprint

            • Instance Cloud-init user-data (base64 encoded)

              Minimum length is 1.

            • Instance MAC address

            • manager object

              Instance manager

              Additional properties are allowed.

              Hide manager attributes Show manager attributes object
              • id string(uuid)

                Manager ID

              • type string

                Manager type

                Values are sks-nodepool or instance-pool.

            • Instance Deploy Target

              Additional properties are allowed.

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

                Deploy Target ID

              • name string

                Deploy Target name

                Minimum length is 1, maximum length is 255.

              • type string

                Deploy Target type

                Values are edge or dedicated.

              • Deploy Target description

                Maximum length is 255.

            • Instance IPv6 address

            • id string(uuid)

              Instance ID

            • snapshots array[object]

              Instance Snapshots

              Hide snapshots attributes Show snapshots attributes object
              • id string(uuid)

                Snapshot ID

              • name string

                Snapshot name

                Minimum length is 1, maximum length is 255.

              • created-at string(date-time)

                Snapshot creation date

              • state string

                Snapshot state

                Values are snapshotting, deleted, exporting, ready, deleting, error, or exported.

              • size integer(int64)

                Snapshot size in GiB

                Minimum value is 10, maximum value is 51200.

              • export object

                Exported snapshot information

                Additional properties are allowed.

                Hide export attributes Show export attributes object
                • Exported snapshot disk file pre-signed URL

                • md5sum string

                  Exported snapshot disk file MD5 checksum

              • instance object

                Compute Instance snapshotted

                Additional properties are allowed.

            • disk-size integer(int64)

              Instance disk size in GiB

              Minimum value is 10, maximum value is 51200.

            • ssh-keys array[object]

              Instance SSH Keys

              Hide ssh-keys attributes Show ssh-keys attributes object
              • name string

                SSH key name

                Minimum length is 1, maximum length is 255.

              • SSH key fingerprint

            • created-at string(date-time)

              Instance creation date

            • public-ip string(ipv4)

              Instance public IPv4 address

        • Nodepool description

          Maximum length is 255.

        • Nodepool public IP assignment of the Instances:

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

          Values are inet4 or dual.

        • labels object

          Resource labels

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

          Nodepool taints

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

            Nodepool taint

            Additional properties are allowed.

            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

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

            Security Group ID

          • name string

            Security Group name

            Minimum length is 1, maximum length is 255.

          • Security Group description

            Maximum length is 255.

          • external-sources array[string]

            Security Group external sources

        • name string

          Nodepool name

          Minimum length is 1, maximum length is 255.

        • Instance Type

          Additional properties are allowed.

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

            Instance type ID

          • size string

            Instance type size

            Values are large, huge, jumbo, medium, mega, small, extra-large, titan, micro, colossus, or tiny.

          • family string

            Instance type family

            Values are gpu3, gpu2, gpu, memory, storage, standard, colossus, or cpu.

          • cpus integer(int64)

            CPU count

            Minimum value is 0.

          • gpus integer(int64)

            GPU count

            Minimum value is 0.

          • authorized boolean

            Requires authorization or publicly available

          • memory integer(int64)

            Available memory

            Minimum value is 0.

          • zones array[string]

            Instance Type available zones

            Values are ch-dk-2, de-muc-1, ch-gva-2, at-vie-1, de-fra-1, bg-sof-1, or at-vie-2.

        • private-networks array[object]

          Nodepool Private Networks

          Hide private-networks attributes Show private-networks attributes object
          • Private Network description

            Maximum length is 255.

          • labels object

            Resource labels

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

            Private Network name

            Minimum length is 1, maximum length is 255.

          • start-ip string(ipv4)

            Private Network start IP address

          • leases array[object]

            Private Network leased IP addresses

            Hide leases attributes Show leases attributes object
            • ip string(ipv4)

              Private Network IP address

            • instance-id string(uuid)

              Attached instance ID

          • id string(uuid)

            Private Network ID

          • vni integer(int64)

            Private Network VXLAN ID

            Minimum value is 0.

          • netmask string(ipv4)

            Private Network netmask

          • options object

            DHCP options

            Additional properties are allowed.

            Hide options attributes Show options attributes object
          • end-ip string(ipv4)

            Private Network end IP address

        • template object

          Instance Template

          Additional properties are allowed.

          Hide template attributes Show template attributes object
          • Template maintainer

          • Template description

            Maximum length is 255.

          • Enable SSH key-based login

          • family string

            Template family

          • name string

            Template name

            Minimum length is 1, maximum length is 255.

          • Template default user

            Minimum length is 1, maximum length is 255.

          • size integer(int64)

            Template size

            Minimum value is 0.

          • Enable password-based login

          • build string

            Template build

          • checksum string

            Template MD5 checksum

          • Boot mode (default: legacy)

            Values are legacy or uefi.

          • id string(uuid)

            Template ID

          • zones array[string]

            Zones availability

            Values are ch-dk-2, de-muc-1, ch-gva-2, at-vie-1, de-fra-1, bg-sof-1, or at-vie-2.

          • url string

            Template source URL

          • version string

            Template version

          • created-at string(date-time)

            Template creation date

          • Template visibility

            Values are private or public.

        • 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 options

          Additional properties are allowed.

          Hide kubelet-image-gc attributes Show kubelet-image-gc attributes object
        • Instance Pool to forward network traffic to

          Additional properties are allowed.

          Hide instance-pool attributes Show instance-pool attributes object
          • Instance Pool Anti-affinity Groups

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

              Anti-affinity Group ID

            • name string

              Anti-affinity Group name

              Minimum length is 1, maximum length is 255.

            • Anti-affinity Group description

              Maximum length is 255.

            • instances array[object]

              Anti-affinity Group instances

              Hide instances attributes Show instances attributes object
              • Instance Anti-affinity Groups

                Anti-affinity Group

                Additional properties are allowed.

              • Instance public IP assignment

                Values are inet4, dual, or none.

              • labels object

                Resource labels

                Hide labels attribute Show labels attribute object
                • * string Additional properties
              • security-groups array[object]

                Instance Security Groups

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

                  Security Group ID

                • name string

                  Security Group name

                  Minimum length is 1, maximum length is 255.

                • Security Group description

                  Maximum length is 255.

                • external-sources array[string]

                  Security Group external sources

              • elastic-ips array[object]

                Instance Elastic IPs

                Hide elastic-ips attributes Show elastic-ips attributes object
                • id string(uuid)

                  Elastic IP ID

                • ip string

                  Elastic IP address

                • Elastic IP address family

                  Values are inet4 or inet6.

                • cidr string

                  Elastic IP cidr

                • Elastic IP description

                  Maximum length is 255.

                • Elastic IP healthcheck

                  Additional properties are allowed.

                  Hide healthcheck attributes Show healthcheck attributes object
                  • strikes-ok integer(int64)

                    Number of attempts before considering the target healthy (default: 2)

                    Minimum value is 1, maximum value is 20.

                  • Skip TLS verification

                  • tls-sni string

                    An optional domain or subdomain to check TLS against

                    Minimum length is 1, maximum length is 255.

                  • strikes-fail integer(int64)

                    Number of attempts before considering the target unhealthy (default: 3)

                    Minimum value is 1, maximum value is 20.

                  • mode string Required

                    Health check mode

                    Values are tcp, http, or https.

                  • port integer(int64) Required

                    Health check port

                    Minimum value is 1, maximum value is 65535.

                  • uri string

                    An endpoint to use for the health check, for example '/status'

                    Minimum length is 1, maximum length is 255.

                  • interval integer(int64)

                    Interval between the checks in seconds (default: 10)

                    Minimum value is 5, maximum value is 300.

                  • timeout integer(int64)

                    Health check timeout value in seconds (default: 2)

                    Minimum value is 2, maximum value is 60.

                • labels object

                  Resource labels

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

                Instance name

                Minimum length is 1, maximum length is 255.

              • Instance Type

                Additional properties are allowed.

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

                  Instance type ID

                • size string

                  Instance type size

                  Values are large, huge, jumbo, medium, mega, small, extra-large, titan, micro, colossus, or tiny.

                • family string

                  Instance type family

                  Values are gpu3, gpu2, gpu, memory, storage, standard, colossus, or cpu.

                • cpus integer(int64)

                  CPU count

                  Minimum value is 0.

                • gpus integer(int64)

                  GPU count

                  Minimum value is 0.

                • authorized boolean

                  Requires authorization or publicly available

                • memory integer(int64)

                  Available memory

                  Minimum value is 0.

                • zones array[string]

                  Instance Type available zones

                  Values are ch-dk-2, de-muc-1, ch-gva-2, at-vie-1, de-fra-1, bg-sof-1, or at-vie-2.

              • private-networks array[object]

                Instance Private Networks

                Hide private-networks attributes Show private-networks attributes object
              • template object

                Instance Template

                Additional properties are allowed.

                Hide template attributes Show template attributes object
                • Template maintainer

                • Template description

                  Maximum length is 255.

                • Enable SSH key-based login

                • family string

                  Template family

                • name string

                  Template name

                  Minimum length is 1, maximum length is 255.

                • Template default user

                  Minimum length is 1, maximum length is 255.

                • size integer(int64)

                  Template size

                  Minimum value is 0.

                • Enable password-based login

                • build string

                  Template build

                • checksum string

                  Template MD5 checksum

                • Boot mode (default: legacy)

                  Values are legacy or uefi.

                • id string(uuid)

                  Template ID

                • zones array[string]

                  Zones availability

                  Values are ch-dk-2, de-muc-1, ch-gva-2, at-vie-1, de-fra-1, bg-sof-1, or at-vie-2.

                • url string

                  Template source URL

                • version string

                  Template version

                • created-at string(date-time)

                  Template creation date

                • Template visibility

                  Values are private or public.

              • state string

                Instance state

                Values are expunging, starting, destroying, running, stopping, stopped, migrating, error, or destroyed.

              • ssh-key object

                Instance SSH Key

                Additional properties are allowed.

                Hide ssh-key attributes Show ssh-key attributes object
                • name string

                  SSH key name

                  Minimum length is 1, maximum length is 255.

                • SSH key fingerprint

              • Instance Cloud-init user-data (base64 encoded)

                Minimum length is 1.

              • Instance MAC address

              • manager object

                Instance manager

                Additional properties are allowed.

                Hide manager attributes Show manager attributes object
                • id string(uuid)

                  Manager ID

                • type string

                  Manager type

                  Values are sks-nodepool or instance-pool.

              • Instance Deploy Target

                Additional properties are allowed.

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

                  Deploy Target ID

                • name string

                  Deploy Target name

                  Minimum length is 1, maximum length is 255.

                • type string

                  Deploy Target type

                  Values are edge or dedicated.

                • Deploy Target description

                  Maximum length is 255.

              • Instance IPv6 address

              • id string(uuid)

                Instance ID

              • snapshots array[object]

                Instance Snapshots

                Hide snapshots attributes Show snapshots attributes object
                • id string(uuid)

                  Snapshot ID

                • name string

                  Snapshot name

                  Minimum length is 1, maximum length is 255.

                • created-at string(date-time)

                  Snapshot creation date

                • state string

                  Snapshot state

                  Values are snapshotting, deleted, exporting, ready, deleting, error, or exported.

                • size integer(int64)

                  Snapshot size in GiB

                  Minimum value is 10, maximum value is 51200.

                • export object

                  Exported snapshot information

                  Additional properties are allowed.

                  Hide export attributes Show export attributes object
                  • Exported snapshot disk file pre-signed URL

                  • md5sum string

                    Exported snapshot disk file MD5 checksum

                • instance object

                  Compute Instance snapshotted

                  Additional properties are allowed.

              • disk-size integer(int64)

                Instance disk size in GiB

                Minimum value is 10, maximum value is 51200.

              • ssh-keys array[object]

                Instance SSH Keys

                Hide ssh-keys attributes Show ssh-keys attributes object
                • name string

                  SSH key name

                  Minimum length is 1, maximum length is 255.

                • SSH key fingerprint

              • created-at string(date-time)

                Instance creation date

              • public-ip string(ipv4)

                Instance public IPv4 address

          • Instance Pool description

            Minimum length is 1, maximum length is 255.

          • Instance public IP assignment

            Values are inet4, dual, or none.

          • labels object

            Resource labels

            Hide labels attribute Show labels attribute object
            • * string Additional properties
          • security-groups array[object]

            Instance Pool Security Groups

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

              Security Group ID

            • name string

              Security Group name

              Minimum length is 1, maximum length is 255.

            • Security Group description

              Maximum length is 255.

            • external-sources array[string]

              Security Group external sources

          • elastic-ips array[object]

            Instances Elastic IPs

            Hide elastic-ips attributes Show elastic-ips attributes object
            • id string(uuid)

              Elastic IP ID

            • ip string

              Elastic IP address

            • Elastic IP address family

              Values are inet4 or inet6.

            • cidr string

              Elastic IP cidr

            • Elastic IP description

              Maximum length is 255.

            • Elastic IP healthcheck

              Additional properties are allowed.

              Hide healthcheck attributes Show healthcheck attributes object
              • strikes-ok integer(int64)

                Number of attempts before considering the target healthy (default: 2)

                Minimum value is 1, maximum value is 20.

              • Skip TLS verification

              • tls-sni string

                An optional domain or subdomain to check TLS against

                Minimum length is 1, maximum length is 255.

              • strikes-fail integer(int64)

                Number of attempts before considering the target unhealthy (default: 3)

                Minimum value is 1, maximum value is 20.

              • mode string Required

                Health check mode

                Values are tcp, http, or https.

              • port integer(int64) Required

                Health check port

                Minimum value is 1, maximum value is 65535.

              • uri string

                An endpoint to use for the health check, for example '/status'

                Minimum length is 1, maximum length is 255.

              • interval integer(int64)

                Interval between the checks in seconds (default: 10)

                Minimum value is 5, maximum value is 300.

              • timeout integer(int64)

                Health check timeout value in seconds (default: 2)

                Minimum value is 2, maximum value is 60.

            • labels object

              Resource labels

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

            Instance Pool name

            Minimum length is 1, maximum length is 255.

          • Instance Type

            Additional properties are allowed.

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

              Instance type ID

            • size string

              Instance type size

              Values are large, huge, jumbo, medium, mega, small, extra-large, titan, micro, colossus, or tiny.

            • family string

              Instance type family

              Values are gpu3, gpu2, gpu, memory, storage, standard, colossus, or cpu.

            • cpus integer(int64)

              CPU count

              Minimum value is 0.

            • gpus integer(int64)

              GPU count

              Minimum value is 0.

            • authorized boolean

              Requires authorization or publicly available

            • memory integer(int64)

              Available memory

              Minimum value is 0.

            • zones array[string]

              Instance Type available zones

              Values are ch-dk-2, de-muc-1, ch-gva-2, at-vie-1, de-fra-1, bg-sof-1, or at-vie-2.

          • min-available integer(int64)

            Minimum number of running instances

            Minimum value is 0.

          • private-networks array[object]

            Instance Pool Private Networks

            Hide private-networks attributes Show private-networks attributes object
            • Private Network description

              Maximum length is 255.

            • labels object

              Resource labels

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

              Private Network name

              Minimum length is 1, maximum length is 255.

            • start-ip string(ipv4)

              Private Network start IP address

            • leases array[object]

              Private Network leased IP addresses

              Hide leases attributes Show leases attributes object
              • ip string(ipv4)

                Private Network IP address

              • instance-id string(uuid)

                Attached instance ID

            • id string(uuid)

              Private Network ID

            • vni integer(int64)

              Private Network VXLAN ID

              Minimum value is 0.

            • netmask string(ipv4)

              Private Network netmask

            • options object

              DHCP options

              Additional properties are allowed.

              Hide options attributes Show options attributes object
            • end-ip string(ipv4)

              Private Network end IP address

          • template object

            Instance Template

            Additional properties are allowed.

            Hide template attributes Show template attributes object
            • Template maintainer

            • Template description

              Maximum length is 255.

            • Enable SSH key-based login

            • family string

              Template family

            • name string

              Template name

              Minimum length is 1, maximum length is 255.

            • Template default user

              Minimum length is 1, maximum length is 255.

            • size integer(int64)

              Template size

              Minimum value is 0.

            • Enable password-based login

            • build string

              Template build

            • checksum string

              Template MD5 checksum

            • Boot mode (default: legacy)

              Values are legacy or uefi.

            • id string(uuid)

              Template ID

            • zones array[string]

              Zones availability

              Values are ch-dk-2, de-muc-1, ch-gva-2, at-vie-1, de-fra-1, bg-sof-1, or at-vie-2.

            • url string

              Template source URL

            • version string

              Template version

            • created-at string(date-time)

              Template creation date

            • Template visibility

              Values are private or public.

          • state string

            Instance Pool state

            Values are scaling-up, scaling-down, destroying, creating, suspended, running, or updating.

          • size integer(int64)

            Number of instances

            Minimum value is 0.

          • ssh-key object

            Instance SSH Key

            Additional properties are allowed.

            Hide ssh-key attributes Show ssh-key attributes object
            • name string

              SSH key name

              Minimum length is 1, maximum length is 255.

            • SSH key fingerprint

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

            Minimum length is 1, maximum length is 30.

          • Instances Cloud-init user-data

            Minimum length is 1.

          • manager object

            Instance manager

            Additional properties are allowed.

            Hide manager attributes Show manager attributes object
            • id string(uuid)

              Manager ID

            • type string

              Manager type

              Values are sks-nodepool or instance-pool.

          • instances array[object]

            Instances

            Hide instances attributes Show instances attributes object
            • Instance Anti-affinity Groups

              Anti-affinity Group

              Additional properties are allowed.

            • Instance public IP assignment

              Values are inet4, dual, or none.

            • labels object

              Resource labels

              Hide labels attribute Show labels attribute object
              • * string Additional properties
            • security-groups array[object]

              Instance Security Groups

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

                Security Group ID

              • name string

                Security Group name

                Minimum length is 1, maximum length is 255.

              • Security Group description

                Maximum length is 255.

              • external-sources array[string]

                Security Group external sources

            • elastic-ips array[object]

              Instance Elastic IPs

              Hide elastic-ips attributes Show elastic-ips attributes object
              • id string(uuid)

                Elastic IP ID

              • ip string

                Elastic IP address

              • Elastic IP address family

                Values are inet4 or inet6.

              • cidr string

                Elastic IP cidr

              • Elastic IP description

                Maximum length is 255.

              • Elastic IP healthcheck

                Additional properties are allowed.

                Hide healthcheck attributes Show healthcheck attributes object
                • strikes-ok integer(int64)

                  Number of attempts before considering the target healthy (default: 2)

                  Minimum value is 1, maximum value is 20.

                • Skip TLS verification

                • tls-sni string

                  An optional domain or subdomain to check TLS against

                  Minimum length is 1, maximum length is 255.

                • strikes-fail integer(int64)

                  Number of attempts before considering the target unhealthy (default: 3)

                  Minimum value is 1, maximum value is 20.

                • mode string Required

                  Health check mode

                  Values are tcp, http, or https.

                • port integer(int64) Required

                  Health check port

                  Minimum value is 1, maximum value is 65535.

                • uri string

                  An endpoint to use for the health check, for example '/status'

                  Minimum length is 1, maximum length is 255.

                • interval integer(int64)

                  Interval between the checks in seconds (default: 10)

                  Minimum value is 5, maximum value is 300.

                • timeout integer(int64)

                  Health check timeout value in seconds (default: 2)

                  Minimum value is 2, maximum value is 60.

              • labels object

                Resource labels

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

              Instance name

              Minimum length is 1, maximum length is 255.

            • Instance Type

              Additional properties are allowed.

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

                Instance type ID

              • size string

                Instance type size

                Values are large, huge, jumbo, medium, mega, small, extra-large, titan, micro, colossus, or tiny.

              • family string

                Instance type family

                Values are gpu3, gpu2, gpu, memory, storage, standard, colossus, or cpu.

              • cpus integer(int64)

                CPU count

                Minimum value is 0.

              • gpus integer(int64)

                GPU count

                Minimum value is 0.

              • authorized boolean

                Requires authorization or publicly available

              • memory integer(int64)

                Available memory

                Minimum value is 0.

              • zones array[string]

                Instance Type available zones

                Values are ch-dk-2, de-muc-1, ch-gva-2, at-vie-1, de-fra-1, bg-sof-1, or at-vie-2.

            • private-networks array[object]

              Instance Private Networks

              Hide private-networks attributes Show private-networks attributes object
            • template object

              Instance Template

              Additional properties are allowed.

              Hide template attributes Show template attributes object
              • Template maintainer

              • Template description

                Maximum length is 255.

              • Enable SSH key-based login

              • family string

                Template family

              • name string

                Template name

                Minimum length is 1, maximum length is 255.

              • Template default user

                Minimum length is 1, maximum length is 255.

              • size integer(int64)

                Template size

                Minimum value is 0.

              • Enable password-based login

              • build string

                Template build

              • checksum string

                Template MD5 checksum

              • Boot mode (default: legacy)

                Values are legacy or uefi.

              • id string(uuid)

                Template ID

              • zones array[string]

                Zones availability

                Values are ch-dk-2, de-muc-1, ch-gva-2, at-vie-1, de-fra-1, bg-sof-1, or at-vie-2.

              • url string

                Template source URL

              • version string

                Template version

              • created-at string(date-time)

                Template creation date

              • Template visibility

                Values are private or public.

            • state string

              Instance state

              Values are expunging, starting, destroying, running, stopping, stopped, migrating, error, or destroyed.

            • ssh-key object

              Instance SSH Key

              Additional properties are allowed.

              Hide ssh-key attributes Show ssh-key attributes object
              • name string

                SSH key name

                Minimum length is 1, maximum length is 255.

              • SSH key fingerprint

            • Instance Cloud-init user-data (base64 encoded)

              Minimum length is 1.

            • Instance MAC address

            • manager object

              Instance manager

              Additional properties are allowed.

              Hide manager attributes Show manager attributes object
              • id string(uuid)

                Manager ID

              • type string

                Manager type

                Values are sks-nodepool or instance-pool.

            • Instance Deploy Target

              Additional properties are allowed.

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

                Deploy Target ID

              • name string

                Deploy Target name

                Minimum length is 1, maximum length is 255.

              • type string

                Deploy Target type

                Values are edge or dedicated.

              • Deploy Target description

                Maximum length is 255.

            • Instance IPv6 address

            • id string(uuid)

              Instance ID

            • snapshots array[object]

              Instance Snapshots

              Hide snapshots attributes Show snapshots attributes object
              • id string(uuid)

                Snapshot ID

              • name string

                Snapshot name

                Minimum length is 1, maximum length is 255.

              • created-at string(date-time)

                Snapshot creation date

              • state string

                Snapshot state

                Values are snapshotting, deleted, exporting, ready, deleting, error, or exported.

              • size integer(int64)

                Snapshot size in GiB

                Minimum value is 10, maximum value is 51200.

              • export object

                Exported snapshot information

                Additional properties are allowed.

                Hide export attributes Show export attributes object
                • Exported snapshot disk file pre-signed URL

                • md5sum string

                  Exported snapshot disk file MD5 checksum

              • instance object

                Compute Instance snapshotted

                Additional properties are allowed.

            • disk-size integer(int64)

              Instance disk size in GiB

              Minimum value is 10, maximum value is 51200.

            • ssh-keys array[object]

              Instance SSH Keys

              Hide ssh-keys attributes Show ssh-keys attributes object
              • name string

                SSH key name

                Minimum length is 1, maximum length is 255.

              • SSH key fingerprint

            • created-at string(date-time)

              Instance creation date

            • public-ip string(ipv4)

              Instance public IPv4 address

          • Instance Deploy Target

            Additional properties are allowed.

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

              Deploy Target ID

            • name string

              Deploy Target name

              Minimum length is 1, maximum length is 255.

            • type string

              Deploy Target type

              Values are edge or dedicated.

            • Deploy Target description

              Maximum length is 255.

          • Enable IPv6 for instances

          • id string(uuid)

            Instance Pool ID

          • disk-size integer(int64)

            Instances disk size in GiB

            Minimum value is 10, maximum value is 51200.

          • ssh-keys array[object]

            Instances SSH keys

            Hide ssh-keys attributes Show ssh-keys attributes object
            • name string

              SSH key name

              Minimum length is 1, maximum length is 255.

            • SSH key fingerprint

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

          Minimum length is 1, maximum length is 30.

        • Instance Deploy Target

          Additional properties are allowed.

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

            Deploy Target ID

          • name string

            Deploy Target name

            Minimum length is 1, maximum length is 255.

          • type string

            Deploy Target type

            Values are edge or dedicated.

          • Deploy Target description

            Maximum length is 255.

        • 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.

      • addons array[string]

        Cluster addons

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

      • id string(uuid)

        Cluster ID

      • version string

        Control plane Kubernetes version

      • created-at string(date-time)

        Cluster creation date

      • endpoint string

        Cluster endpoint

GET /sks-cluster
curl \
 -X GET https://api-ch-gva-2.exoscale.com/v2/sks-cluster
Response examples (200)
{
  "sks-clusters": [
    {
      "description": "string",
      "labels": {
        "additionalProperty1": "string",
        "additionalProperty2": "string"
      },
      "cni": "calico",
      "auto-upgrade": true,
      "name": "string",
      "state": "rotating-ccm-credentials",
      "nodepools": [
        {
          "anti-affinity-groups": [
            {
              "id": "string",
              "name": "string",
              "description": "string",
              "instances": [
                {
                  "anti-affinity-groups": [
                    {}
                  ],
                  "public-ip-assignment": "inet4",
                  "labels": {
                    "additionalProperty1": "string",
                    "additionalProperty2": "string"
                  },
                  "security-groups": [
                    {
                      "id": "string",
                      "name": "string",
                      "description": "string",
                      "external-sources": [
                        "string"
                      ]
                    }
                  ],
                  "elastic-ips": [
                    {
                      "id": "string",
                      "ip": "string",
                      "addressfamily": "inet4",
                      "cidr": "string",
                      "description": "string",
                      "healthcheck": {
                        "strikes-ok": 42,
                        "tls-skip-verify": true,
                        "tls-sni": "string",
                        "strikes-fail": 42,
                        "mode": "tcp",
                        "port": 42,
                        "uri": "string",
                        "interval": 42,
                        "timeout": 42
                      },
                      "labels": {
                        "additionalProperty1": "string",
                        "additionalProperty2": "string"
                      }
                    }
                  ],
                  "name": "string",
                  "instance-type": {
                    "id": "string",
                    "size": "large",
                    "family": "gpu3",
                    "cpus": 42,
                    "gpus": 42,
                    "authorized": true,
                    "memory": 42,
                    "zones": [
                      "ch-dk-2"
                    ]
                  },
                  "private-networks": [
                    {
                      "id": "string",
                      "mac-address": "string"
                    }
                  ],
                  "template": {
                    "maintainer": "string",
                    "description": "string",
                    "ssh-key-enabled": true,
                    "family": "string",
                    "name": "string",
                    "default-user": "string",
                    "size": 42,
                    "password-enabled": true,
                    "build": "string",
                    "checksum": "string",
                    "boot-mode": "legacy",
                    "id": "string",
                    "zones": [
                      "ch-dk-2"
                    ],
                    "url": "string",
                    "version": "string",
                    "created-at": "2024-05-04T09:42:00+00:00",
                    "visibility": "private"
                  },
                  "state": "expunging",
                  "ssh-key": {
                    "name": "string",
                    "fingerprint": "string"
                  },
                  "user-data": "string",
                  "mac-address": "string",
                  "manager": {
                    "id": "string",
                    "type": "sks-nodepool"
                  },
                  "deploy-target": {
                    "id": "string",
                    "name": "string",
                    "type": "edge",
                    "description": "string"
                  },
                  "ipv6-address": "string",
                  "id": "string",
                  "snapshots": [
                    {
                      "id": "string",
                      "name": "string",
                      "created-at": "2024-05-04T09:42:00+00:00",
                      "state": "snapshotting",
                      "size": 42,
                      "export": {
                        "presigned-url": "string",
                        "md5sum": "string"
                      },
                      "instance": {}
                    }
                  ],
                  "disk-size": 42,
                  "ssh-keys": [
                    {
                      "name": "string",
                      "fingerprint": "string"
                    }
                  ],
                  "created-at": "2024-05-04T09:42:00+00:00",
                  "public-ip": "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",
              "description": "string",
              "external-sources": [
                "string"
              ]
            }
          ],
          "name": "string",
          "instance-type": {
            "id": "string",
            "size": "large",
            "family": "gpu3",
            "cpus": 42,
            "gpus": 42,
            "authorized": true,
            "memory": 42,
            "zones": [
              "ch-dk-2"
            ]
          },
          "private-networks": [
            {
              "description": "string",
              "labels": {
                "additionalProperty1": "string",
                "additionalProperty2": "string"
              },
              "name": "string",
              "start-ip": "string",
              "leases": [
                {
                  "ip": "string",
                  "instance-id": "string"
                }
              ],
              "id": "string",
              "vni": 42,
              "netmask": "string",
              "options": {
                "routers": [
                  "string"
                ],
                "dns-servers": [
                  "string"
                ],
                "ntp-servers": [
                  "string"
                ],
                "domain-search": [
                  "string"
                ]
              },
              "end-ip": "string"
            }
          ],
          "template": {
            "maintainer": "string",
            "description": "string",
            "ssh-key-enabled": true,
            "family": "string",
            "name": "string",
            "default-user": "string",
            "size": 42,
            "password-enabled": true,
            "build": "string",
            "checksum": "string",
            "boot-mode": "legacy",
            "id": "string",
            "zones": [
              "ch-dk-2"
            ],
            "url": "string",
            "version": "string",
            "created-at": "2024-05-04T09:42:00+00:00",
            "visibility": "private"
          },
          "state": "renewing-token",
          "size": 42,
          "kubelet-image-gc": {
            "high-threshold": 42,
            "low-threshold": 42,
            "min-age": "string"
          },
          "instance-pool": {
            "anti-affinity-groups": [
              {
                "id": "string",
                "name": "string",
                "description": "string",
                "instances": [
                  {
                    "anti-affinity-groups": [
                      {}
                    ],
                    "public-ip-assignment": "inet4",
                    "labels": {
                      "additionalProperty1": "string",
                      "additionalProperty2": "string"
                    },
                    "security-groups": [
                      {
                        "id": "string",
                        "name": "string",
                        "description": "string",
                        "external-sources": [
                          "string"
                        ]
                      }
                    ],
                    "elastic-ips": [
                      {
                        "id": "string",
                        "ip": "string",
                        "addressfamily": "inet4",
                        "cidr": "string",
                        "description": "string",
                        "healthcheck": {
                          "strikes-ok": 42,
                          "tls-skip-verify": true,
                          "tls-sni": "string",
                          "strikes-fail": 42,
                          "mode": "tcp",
                          "port": 42,
                          "uri": "string",
                          "interval": 42,
                          "timeout": 42
                        },
                        "labels": {
                          "additionalProperty1": "string",
                          "additionalProperty2": "string"
                        }
                      }
                    ],
                    "name": "string",
                    "instance-type": {
                      "id": "string",
                      "size": "large",
                      "family": "gpu3",
                      "cpus": 42,
                      "gpus": 42,
                      "authorized": true,
                      "memory": 42,
                      "zones": [
                        "ch-dk-2"
                      ]
                    },
                    "private-networks": [
                      {
                        "id": "string",
                        "mac-address": "string"
                      }
                    ],
                    "template": {
                      "maintainer": "string",
                      "description": "string",
                      "ssh-key-enabled": true,
                      "family": "string",
                      "name": "string",
                      "default-user": "string",
                      "size": 42,
                      "password-enabled": true,
                      "build": "string",
                      "checksum": "string",
                      "boot-mode": "legacy",
                      "id": "string",
                      "zones": [
                        "ch-dk-2"
                      ],
                      "url": "string",
                      "version": "string",
                      "created-at": "2024-05-04T09:42:00+00:00",
                      "visibility": "private"
                    },
                    "state": "expunging",
                    "ssh-key": {
                      "name": "string",
                      "fingerprint": "string"
                    },
                    "user-data": "string",
                    "mac-address": "string",
                    "manager": {
                      "id": "string",
                      "type": "sks-nodepool"
                    },
                    "deploy-target": {
                      "id": "string",
                      "name": "string",
                      "type": "edge",
                      "description": "string"
                    },
                    "ipv6-address": "string",
                    "id": "string",
                    "snapshots": [
                      {
                        "id": "string",
                        "name": "string",
                        "created-at": "2024-05-04T09:42:00+00:00",
                        "state": "snapshotting",
                        "size": 42,
                        "export": {
                          "presigned-url": "string",
                          "md5sum": "string"
                        },
                        "instance": {}
                      }
                    ],
                    "disk-size": 42,
                    "ssh-keys": [
                      {
                        "name": "string",
                        "fingerprint": "string"
                      }
                    ],
                    "created-at": "2024-05-04T09:42:00+00:00",
                    "public-ip": "string"
                  }
                ]
              }
            ],
            "description": "string",
            "public-ip-assignment": "inet4",
            "labels": {
              "additionalProperty1": "string",
              "additionalProperty2": "string"
            },
            "security-groups": [
              {
                "id": "string",
                "name": "string",
                "description": "string",
                "external-sources": [
                  "string"
                ]
              }
            ],
            "elastic-ips": [
              {
                "id": "string",
                "ip": "string",
                "addressfamily": "inet4",
                "cidr": "string",
                "description": "string",
                "healthcheck": {
                  "strikes-ok": 42,
                  "tls-skip-verify": true,
                  "tls-sni": "string",
                  "strikes-fail": 42,
                  "mode": "tcp",
                  "port": 42,
                  "uri": "string",
                  "interval": 42,
                  "timeout": 42
                },
                "labels": {
                  "additionalProperty1": "string",
                  "additionalProperty2": "string"
                }
              }
            ],
            "name": "string",
            "instance-type": {
              "id": "string",
              "size": "large",
              "family": "gpu3",
              "cpus": 42,
              "gpus": 42,
              "authorized": true,
              "memory": 42,
              "zones": [
                "ch-dk-2"
              ]
            },
            "min-available": 42,
            "private-networks": [
              {
                "description": "string",
                "labels": {
                  "additionalProperty1": "string",
                  "additionalProperty2": "string"
                },
                "name": "string",
                "start-ip": "string",
                "leases": [
                  {
                    "ip": "string",
                    "instance-id": "string"
                  }
                ],
                "id": "string",
                "vni": 42,
                "netmask": "string",
                "options": {
                  "routers": [
                    "string"
                  ],
                  "dns-servers": [
                    "string"
                  ],
                  "ntp-servers": [
                    "string"
                  ],
                  "domain-search": [
                    "string"
                  ]
                },
                "end-ip": "string"
              }
            ],
            "template": {
              "maintainer": "string",
              "description": "string",
              "ssh-key-enabled": true,
              "family": "string",
              "name": "string",
              "default-user": "string",
              "size": 42,
              "password-enabled": true,
              "build": "string",
              "checksum": "string",
              "boot-mode": "legacy",
              "id": "string",
              "zones": [
                "ch-dk-2"
              ],
              "url": "string",
              "version": "string",
              "created-at": "2024-05-04T09:42:00+00:00",
              "visibility": "private"
            },
            "state": "scaling-up",
            "size": 42,
            "ssh-key": {
              "name": "string",
              "fingerprint": "string"
            },
            "instance-prefix": "string",
            "user-data": "string",
            "manager": {
              "id": "string",
              "type": "sks-nodepool"
            },
            "instances": [
              {
                "anti-affinity-groups": [
                  {}
                ],
                "public-ip-assignment": "inet4",
                "labels": {
                  "additionalProperty1": "string",
                  "additionalProperty2": "string"
                },
                "security-groups": [
                  {
                    "id": "string",
                    "name": "string",
                    "description": "string",
                    "external-sources": [
                      "string"
                    ]
                  }
                ],
                "elastic-ips": [
                  {
                    "id": "string",
                    "ip": "string",
                    "addressfamily": "inet4",
                    "cidr": "string",
                    "description": "string",
                    "healthcheck": {
                      "strikes-ok": 42,
                      "tls-skip-verify": true,
                      "tls-sni": "string",
                      "strikes-fail": 42,
                      "mode": "tcp",
                      "port": 42,
                      "uri": "string",
                      "interval": 42,
                      "timeout": 42
                    },
                    "labels": {
                      "additionalProperty1": "string",
                      "additionalProperty2": "string"
                    }
                  }
                ],
                "name": "string",
                "instance-type": {
                  "id": "string",
                  "size": "large",
                  "family": "gpu3",
                  "cpus": 42,
                  "gpus": 42,
                  "authorized": true,
                  "memory": 42,
                  "zones": [
                    "ch-dk-2"
                  ]
                },
                "private-networks": [
                  {
                    "id": "string",
                    "mac-address": "string"
                  }
                ],
                "template": {
                  "maintainer": "string",
                  "description": "string",
                  "ssh-key-enabled": true,
                  "family": "string",
                  "name": "string",
                  "default-user": "string",
                  "size": 42,
                  "password-enabled": true,
                  "build": "string",
                  "checksum": "string",
                  "boot-mode": "legacy",
                  "id": "string",
                  "zones": [
                    "ch-dk-2"
                  ],
                  "url": "string",
                  "version": "string",
                  "created-at": "2024-05-04T09:42:00+00:00",
                  "visibility": "private"
                },
                "state": "expunging",
                "ssh-key": {
                  "name": "string",
                  "fingerprint": "string"
                },
                "user-data": "string",
                "mac-address": "string",
                "manager": {
                  "id": "string",
                  "type": "sks-nodepool"
                },
                "deploy-target": {
                  "id": "string",
                  "name": "string",
                  "type": "edge",
                  "description": "string"
                },
                "ipv6-address": "string",
                "id": "string",
                "snapshots": [
                  {
                    "id": "string",
                    "name": "string",
                    "created-at": "2024-05-04T09:42:00+00:00",
                    "state": "snapshotting",
                    "size": 42,
                    "export": {
                      "presigned-url": "string",
                      "md5sum": "string"
                    },
                    "instance": {}
                  }
                ],
                "disk-size": 42,
                "ssh-keys": [
                  {
                    "name": "string",
                    "fingerprint": "string"
                  }
                ],
                "created-at": "2024-05-04T09:42:00+00:00",
                "public-ip": "string"
              }
            ],
            "deploy-target": {
              "id": "string",
              "name": "string",
              "type": "edge",
              "description": "string"
            },
            "ipv6-enabled": true,
            "id": "string",
            "disk-size": 42,
            "ssh-keys": [
              {
                "name": "string",
                "fingerprint": "string"
              }
            ]
          },
          "instance-prefix": "string",
          "deploy-target": {
            "id": "string",
            "name": "string",
            "type": "edge",
            "description": "string"
          },
          "addons": [
            "storage-lvm"
          ],
          "id": "string",
          "disk-size": 42,
          "version": "string",
          "created-at": "2024-05-04T09:42:00+00:00"
        }
      ],
      "level": "starter",
      "addons": [
        "exoscale-cloud-controller"
      ],
      "id": "string",
      "version": "string",
      "created-at": "2024-05-04T09:42:00+00:00",
      "endpoint": "string"
    }
  ]
}