Sign in

v1

latestSwagger 2.02026-08-04232286653.5 KB
Kubernetes Node Pools

Updates a Kubernetes node pool in the project and returns the async operation.

patch/projects/{project_id}/kubernetes/nodepools/{node_pool_id}

Path parameters

project_idstring required

ID of the project that owns the node pool.

node_pool_idstring required

ID of the node pool.

Request body

action'RESERVE' | 'UNRESERVE' | 'UPDATE' required

Action to perform on the node pool: RESERVE, UNRESERVE, or UPDATE. RESERVE and UNRESERVE operations are done synchronously, and so will have succeeded with a 200 response. Defaults to UPDATE if no action is specified.

countinteger required

New number of nodes in the node pool.

ephemeral_storage_for_containerdboolean required

Whether the first local ephemeral NVMe disk is used for containerd storage.

node_labelsobject required

New labels for the node pool. Labels provided in the PATCH request do not modify existing nodes, but apply to any newly created nodes.

node_pool_versionstring required

New Kubernetes node pool version for newly created VMs.

reservation_idstring required

New reservation ID for the node pool.

ssh_public_keystring required

New SSH public key to use for all VMs created from this node pool.

Example request

{
  "action": "UPDATE",
  "count": 4,
  "ephemeral_storage_for_containerd": true,
  "node_labels": {
    "label": "my_node"
  },
  "node_pool_version": "1.30",
  "node_taints": [
    {
      "effect": "NoSchedule",
      "key": "gpu-type",
      "value": "h100"
    }
  ],
  "reservation_id": "ca39e669-47ee-456b-968d-303234fbf99f",
  "ssh_public_key": "ssh-rsa AAAAB3NzaC1yc2EAAAADAQABAAABAQCspdG97nTS/h4PEPq2QD2RYVK1jxFXLFZuSDMI8Rtxpucl6LDZLOghEYoj13lxKQnGtcsM3Iu68lh+4YgZe7CbI6cc/TxPbeAX2HJTqDh0J7+GAlLBHK9tsepC0QlhIDiazJptOPDZ3cesCBXdxSnzEbhDaqgYOfl393cp1fCeOKRIDWEP3H9CM25dCbWF66sTDziLsojJ9dMnxhgKm9/JkZc5gYncLT/2Ey+VWfV9Fs65mGUrBbQOn3c8S/nEk6WRcYn4PFOnIp0Mz+Chb50iCJrW677pllLnkTGSU+4c0H9J5z4HDG0I+91RoiQ0QsayFTYO1JtSn+THLuq98V+D"
}

Response

Example response

{
  "operation": {
    "completed_at": "2021-12-03T19:59:34Z",
    "metadata": "{}",
    "operation_id": "F6EF489C-086E-458D-B812-7962964A28C9",
    "result": "{}",
    "started_at": "2021-12-03T19:58:34Z",
    "state": "IN_PROGRESS"
  }
}