List k8s clusters

Python

import os
from gcore import Gcore

client = Gcore(
    api_key=os.environ.get("GCORE_API_KEY"),  # This is the default and can be omitted
)
k8s_cluster_list = client.cloud.k8s.clusters.list(
    project_id=0,
    region_id=0,
)
print(k8s_cluster_list.count)

{
  "count": 1,
  "results": [
    {
      "add_ons": {
        "slurm": {
          "enabled": true,
          "file_share_id": "cbc94d0e-06c6-4d12-9e86-9782ba14fc8c",
          "ssh_key_ids": [
            "25735292-bd97-44b0-a1af-d7eab876261d",
            "efc01f3a-35b9-4385-89f9-e38439093ee7"
          ],
          "worker_count": 2
        }
      },
      "created_at": "<string>",
      "csi": {
        "nfs": {
          "vast_enabled": true
        }
      },
      "id": "<string>",
      "is_public": true,
      "keypair": "<string>",
      "logging": {
        "destination_region_id": 1,
        "enabled": true,
        "retention_policy": {
          "period": 45
        },
        "topic_name": "my-log-name"
      },
      "name": "<string>",
      "pools": [
        {
          "auto_healing_enabled": true,
          "boot_volume_size": 123,
          "boot_volume_type": "<string>",
          "created_at": "<string>",
          "crio_config": {},
          "flavor_id": "<string>",
          "id": "<string>",
          "is_public_ipv4": true,
          "kubelet_config": {},
          "labels": {},
          "max_node_count": 123,
          "min_node_count": 123,
          "name": "<string>",
          "node_count": 123,
          "status": "<string>",
          "taints": {},
          "servergroup_id": "",
          "servergroup_name": "",
          "servergroup_policy": ""
        }
      ],
      "status": "Deleting",
      "version": "<string>",
      "authentication": {
        "kubeconfig_created_at": "2024-02-15T11:53:03Z",
        "kubeconfig_expires_at": "2026-02-15T11:53:03Z",
        "oidc": {
          "client_id": "kubernetes",
          "groups_claim": "groups",
          "groups_prefix": "oidc:",
          "issuer_url": "https://accounts.provider.example",
          "required_claims": {
            "claim": "value"
          },
          "signing_algs": [
            "RS256",
            "RS512"
          ],
          "username_claim": "sub",
          "username_prefix": "oidc:"
        }
      },
      "autoscaler_config": {
        "scale-down-unneeded-time": "5m"
      },
      "cni": {
        "cilium": {
          "encryption": false,
          "hubble_relay": false,
          "hubble_ui": false,
          "lb_acceleration": false,
          "lb_mode": "snat",
          "mask_size": 24,
          "mask_size_v6": 120,
          "routing_mode": "tunnel",
          "tunnel": "geneve"
        },
        "provider": "calico"
      },
      "creator_task_id": "1772de21-f013-4b70-9f8f-a518985b3bc2",
      "ddos_profile": {
        "enabled": true,
        "fields": [
          {
            "base_field": 10,
            "field_value": [
              45046,
              45047
            ]
          }
        ],
        "profile_template": 29
      },
      "fixed_network": "3fa85f64-5717-4562-b3fc-2c963f66afa6",
      "fixed_subnet": "90729bc3-dd37-4761-ae09-b32f2f0a365b",
      "is_ipv6": false,
      "pods_ip_pool": "172.16.0.0/18",
      "pods_ipv6_pool": "2a03:90c0:88:393::/64",
      "services_ip_pool": "172.24.0.0/18",
      "services_ipv6_pool": "2a03:90c0:88:381::/108",
      "task_id": null
    }
  ]
}

GET

cloud

k8s

clusters

{project_id}

{region_id}

Python

import os
from gcore import Gcore

client = Gcore(
    api_key=os.environ.get("GCORE_API_KEY"),  # This is the default and can be omitted
)
k8s_cluster_list = client.cloud.k8s.clusters.list(
    project_id=0,
    region_id=0,
)
print(k8s_cluster_list.count)

{
  "count": 1,
  "results": [
    {
      "add_ons": {
        "slurm": {
          "enabled": true,
          "file_share_id": "cbc94d0e-06c6-4d12-9e86-9782ba14fc8c",
          "ssh_key_ids": [
            "25735292-bd97-44b0-a1af-d7eab876261d",
            "efc01f3a-35b9-4385-89f9-e38439093ee7"
          ],
          "worker_count": 2
        }
      },
      "created_at": "<string>",
      "csi": {
        "nfs": {
          "vast_enabled": true
        }
      },
      "id": "<string>",
      "is_public": true,
      "keypair": "<string>",
      "logging": {
        "destination_region_id": 1,
        "enabled": true,
        "retention_policy": {
          "period": 45
        },
        "topic_name": "my-log-name"
      },
      "name": "<string>",
      "pools": [
        {
          "auto_healing_enabled": true,
          "boot_volume_size": 123,
          "boot_volume_type": "<string>",
          "created_at": "<string>",
          "crio_config": {},
          "flavor_id": "<string>",
          "id": "<string>",
          "is_public_ipv4": true,
          "kubelet_config": {},
          "labels": {},
          "max_node_count": 123,
          "min_node_count": 123,
          "name": "<string>",
          "node_count": 123,
          "status": "<string>",
          "taints": {},
          "servergroup_id": "",
          "servergroup_name": "",
          "servergroup_policy": ""
        }
      ],
      "status": "Deleting",
      "version": "<string>",
      "authentication": {
        "kubeconfig_created_at": "2024-02-15T11:53:03Z",
        "kubeconfig_expires_at": "2026-02-15T11:53:03Z",
        "oidc": {
          "client_id": "kubernetes",
          "groups_claim": "groups",
          "groups_prefix": "oidc:",
          "issuer_url": "https://accounts.provider.example",
          "required_claims": {
            "claim": "value"
          },
          "signing_algs": [
            "RS256",
            "RS512"
          ],
          "username_claim": "sub",
          "username_prefix": "oidc:"
        }
      },
      "autoscaler_config": {
        "scale-down-unneeded-time": "5m"
      },
      "cni": {
        "cilium": {
          "encryption": false,
          "hubble_relay": false,
          "hubble_ui": false,
          "lb_acceleration": false,
          "lb_mode": "snat",
          "mask_size": 24,
          "mask_size_v6": 120,
          "routing_mode": "tunnel",
          "tunnel": "geneve"
        },
        "provider": "calico"
      },
      "creator_task_id": "1772de21-f013-4b70-9f8f-a518985b3bc2",
      "ddos_profile": {
        "enabled": true,
        "fields": [
          {
            "base_field": 10,
            "field_value": [
              45046,
              45047
            ]
          }
        ],
        "profile_template": 29
      },
      "fixed_network": "3fa85f64-5717-4562-b3fc-2c963f66afa6",
      "fixed_subnet": "90729bc3-dd37-4761-ae09-b32f2f0a365b",
      "is_ipv6": false,
      "pods_ip_pool": "172.16.0.0/18",
      "pods_ipv6_pool": "2a03:90c0:88:393::/64",
      "services_ip_pool": "172.24.0.0/18",
      "services_ipv6_pool": "2a03:90c0:88:381::/108",
      "task_id": null
    }
  ]
}

Authorizations

Authorization

string

header

required

API key for authentication. Make sure to include the word apikey, followed by a single space and then your token. Example: apikey 1234$abcdef

Path Parameters

project_id

integer

required

Project identifier

region_id

integer

required

Region identifier

Response

200 - application/json

List of k8s clusters

count

integer

required

Number of objects

Required range: x >= 0

results

K8sClusterV2Serializer · object[]

required

Objects

Show child attributes

results.add_ons

K8sClusterAddonsV2Serializer · object

required

Cluster add-ons configuration

Show child attributes

results.add_ons.slurm

K8sClusterSlurmAddonV2Serializer · object

required

Slurm add-on configuration

Show child attributes

results.add_ons.slurm.enabled

boolean

required

Indicates whether Slurm add-on is deployed in the cluster.

This add-on is only supported in clusters running Kubernetes v1.31 and v1.32 with at least 1 GPU cluster pool.

ID of a VAST file share used as Slurm storage.

The Slurm add-on creates separate Persistent Volume Claims for different purposes (controller spool, worker spool, jail) on that file share.

Example:

"cbc94d0e-06c6-4d12-9e86-9782ba14fc8c"

results.add_ons.slurm.ssh_key_ids

string<uuid4>[] | null

required

IDs of SSH keys authorized for SSH connection to Slurm login nodes.

Example:

[
  "25735292-bd97-44b0-a1af-d7eab876261d",
  "efc01f3a-35b9-4385-89f9-e38439093ee7"
]

results.add_ons.slurm.worker_count

integer | null

required

Size of the worker pool, i.e. number of worker nodes.

Each Slurm worker node is backed by a Pod scheduled on one of cluster's GPU nodes.

Example:

2

results.created_at

string

required

Function creation date

results.csi

K8sClusterCSIV2Serializer · object

required

Cluster CSI settings

Show child attributes

results.csi.nfs

K8sClusterNFSV2Serializer · object

required

NFS settings

Show child attributes

results.csi.nfs.vast_enabled

boolean

required

Indicates the status of VAST NFS integration

results.id

string

required

Cluster pool uuid

results.is_public

boolean

required

Cluster is public

results.keypair

string

required

Keypair

results.logging

LoggingOutSerializer · object

required

Logging configuration

Show child attributes

results.logging.destination_region_id

integer | null

required

ID of the region in which the logs will be stored

Example:

1

results.logging.enabled

boolean

required

Indicates if log streaming is enabled or disabled

results.logging.topic_name

string | null

required

The topic name to stream logs to

Example:

"my-log-name"

results.logging.retention_policy

LaasIndexRetentionPolicyPydanticSerializer · object

Logs retention policy

Show child attributes

results.logging.retention_policy.period

integer | null

required

Duration of days for which logs must be kept.

Required range: 0 < x <= 1825

Example:

45

Example:

{ "period": 45 }

Example:

{
  "destination_region_id": 1,
  "enabled": true,
  "retention_policy": { "period": 45 },
  "topic_name": "my-log-name"
}

results.name

string

required

Name

results.pools

K8sClusterPoolV2Serializer · object[]

required

pools

Show child attributes

results.pools.auto_healing_enabled

boolean

required

Indicates the status of auto healing

results.pools.boot_volume_size

integer

required

Size of the boot volume

results.pools.boot_volume_type

string

required

Type of the boot volume

results.pools.created_at

string

required

Date of function creation

results.pools.crio_config

Crio Config · object

required

Crio configuration for pool nodes

Show child attributes

results.pools.crio_config.{key}

string

results.pools.flavor_id

string

required

ID of the cluster pool flavor

results.pools.id

string

required

UUID of the cluster pool

results.pools.is_public_ipv4

boolean

required

Indicates if the pool is public

results.pools.kubelet_config

Kubelet Config · object

required

Kubelet configuration for pool nodes

Show child attributes

results.pools.kubelet_config.{key}

string

results.pools.labels

Labels · object

required

Labels applied to the cluster pool

Show child attributes

results.pools.labels.{key}

string

results.pools.max_node_count

integer

required

Maximum node count in the cluster pool

results.pools.min_node_count

integer

required

Minimum node count in the cluster pool

results.pools.name

string

required

Name of the cluster pool

results.pools.node_count

integer

required

Node count in the cluster pool

results.pools.status

string

required

Status of the cluster pool

results.pools.taints

Taints · object

required

Taints applied to the cluster pool

Show child attributes

results.pools.taints.{key}

string

results.pools.servergroup_id

string

default:""

Server group ID

results.pools.servergroup_name

string

default:""

Server group name

results.pools.servergroup_policy

string

default:""

Anti-affinity, affinity or soft-anti-affinity server group policy

results.status

enum<string>

required

Status

Available options:

Deleting,

Provisioned,

Provisioning

results.version

string

required

K8s version

results.authentication

K8sClusterAuthenticationV2Serializer · object

Cluster authentication settings

Show child attributes

results.authentication.kubeconfig_created_at

string<date-time> | null

Kubeconfig creation date

Example:

"2024-02-15T11:53:03Z"

results.authentication.kubeconfig_expires_at

string<date-time> | null

Kubeconfig expiration date

Example:

"2026-02-15T11:53:03Z"

results.authentication.oidc

K8sClusterOIDCV2Serializer · object

OIDC authentication settings

Show child attributes

results.authentication.oidc.client_id

string | null

Client ID

Example:

"kubernetes"

results.authentication.oidc.groups_claim

string | null

JWT claim to use as the user's group

Example:

"groups"

results.authentication.oidc.groups_prefix

string | null

Prefix prepended to group claims

Example:

"oidc:"

results.authentication.oidc.issuer_url

string | null

Issuer URL

Example:

"https://accounts.provider.example"

results.authentication.oidc.required_claims

Required Claims · object

Key-value pairs that describe required claims in the token

Show child attributes

results.authentication.oidc.required_claims.{key}

string

Example:

{ "claim": "value" }

results.authentication.oidc.signing_algs

enum<string>[] | null

Accepted signing algorithms

Available options:

ES256,

ES384,

ES512,

PS256,

PS384,

PS512,

RS256,

RS384,

RS512

Example:

["RS512"]

results.authentication.oidc.username_claim

string | null

JWT claim to use as the user name

Example:

"sub"

results.authentication.oidc.username_prefix

string | null

Prefix prepended to username claims to prevent clashes

Example:

"oidc:"

Example:

{
  "kubeconfig_created_at": "2024-02-15T11:53:03Z",
  "kubeconfig_expires_at": "2026-02-15T11:53:03Z",
  "oidc": {
    "client_id": "kubernetes",
    "groups_claim": "groups",
    "groups_prefix": "oidc:",
    "issuer_url": "https://accounts.provider.example",
    "required_claims": { "claim": "value" },
    "signing_algs": ["RS256", "RS512"],
    "username_claim": "sub",
    "username_prefix": "oidc:"
  }
}

results.autoscaler_config

Autoscaler Config · object

Cluster autoscaler configuration.

It contains overrides to the default cluster-autoscaler parameters provided by the platform.

Show child attributes

results.autoscaler_config.{key}

string

Example:

{ "scale-down-unneeded-time": "5m" }

results.cni

K8sClusterCNIV2Serializer · object

Cluster CNI settings

Show child attributes

results.cni.cilium

K8sClusterCiliumV2Serializer · object

Cilium settings

Show child attributes

results.cni.cilium.encryption

boolean

default:false

Wireguard encryption

results.cni.cilium.hubble_relay

boolean

default:false

Hubble Relay

results.cni.cilium.hubble_ui

boolean

default:false

Hubble UI

results.cni.cilium.lb_acceleration

boolean

default:false

LoadBalancer acceleration

results.cni.cilium.lb_mode

enum<string>

default:snat

LoadBalancer mode

Available options:

dsr,

hybrid,

snat

results.cni.cilium.mask_size

integer

default:24

Mask size for IPv4

results.cni.cilium.mask_size_v6

integer

default:120

Mask size for IPv6

results.cni.cilium.routing_mode

enum<string>

default:tunnel

Routing mode

Available options:

native,

tunnel

results.cni.cilium.tunnel

enum<string>

default:geneve

CNI provider

Available options:

geneve,

vxlan

results.cni.provider

enum<string>

default:calico

CNI provider

Available options:

calico,

cilium

results.creator_task_id

string | null

Task that created this entity

Example:

"1772de21-f013-4b70-9f8f-a518985b3bc2"

results.ddos_profile

K8sClusterDdosProfileV2Serializer · object

Advanced DDoS Protection profile

Show child attributes

results.ddos_profile.enabled

boolean

required

Enable advanced DDoS protection

results.ddos_profile.fields

K8sClusterDdosProfileFieldV2Serializer · object[] | null

DDoS profile parameters

Show child attributes

results.ddos_profile.fields.base_field

integer

required

results.ddos_profile.fields.field_value

any | null

Complex value. Only one of 'value' or 'field_value' must be specified

Example:

[45046, 45047]

results.ddos_profile.fields.value

string | null

Basic value. Only one of 'value' or 'field_value' must be specified

Maximum string length: 500

Example:

null

Example:

[
  {
    "base_field": 10,
    "field_value": [45046, 45047]
  }
]

results.ddos_profile.profile_template

integer | null

DDoS profile template ID

Example:

29

results.ddos_profile.profile_template_name

string | null

DDoS profile template name

Example:

{
  "enabled": true,
  "fields": [
    {
      "base_field": 10,
      "field_value": [45046, 45047]
    }
  ],
  "profile_template": 29
}

results.fixed_network

string | null

default:""

Fixed network id

Example:

"3fa85f64-5717-4562-b3fc-2c963f66afa6"

results.fixed_subnet

string | null

default:""

Fixed subnet id

Example:

"90729bc3-dd37-4761-ae09-b32f2f0a365b"

results.is_ipv6

boolean

default:false

Enable public v6 address

results.pods_ip_pool

string | null

default:172.16.0.0/18

The IP pool for the pods

Example:

"172.16.0.0/18"

results.pods_ipv6_pool

string | null

The IPv6 pool for the pods

Example:

"2a03:90c0:88:393::/64"

results.services_ip_pool

string | null

default:172.24.0.0/18

The IP pool for the services

Example:

"172.24.0.0/18"

results.services_ipv6_pool

string | null

The IPv6 pool for the services

Example:

"2a03:90c0:88:381::/108"

results.task_id

string | null

The UUID of the active task that currently holds a lock on the resource. This lock prevents concurrent modifications to ensure consistency. If null, the resource is not locked.

Example:

null

List k8s cluster flavors Create k8s cluster

⌘I

Overview

IAM

CDN

Managed DNS

Cloud

DDoS Protection

FastEdge

WAAP

Streaming

Object Storage

Resellers

Authorizations

Path Parameters

Response