v1

latestSwagger 2.02026-08-04232286653.5 KB
Kubernetes Node Pools

Starts a rotation of a Kubernetes node pool in the project and returns the async operation.

A successful response returns an async operation you can poll.

post/projects/{project_id}/kubernetes/nodepools/{node_pool_id}/rotate

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

countinteger required

Number of nodes to replace at a time when the strategy is 'count'.

percentageinteger required

Percentage of nodes to replace at a time when the strategy is 'percentage'.

strategy'count' | 'percentage' required

Strategy for the rotation to perform: count or percentage.

Example request

{
  "count": 2,
  "percentage": 20,
  "strategy": "count"
}

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"
  }
}