Update node pool inside a cluster.

PUT

/api/v1/orgs/{organisationSlug}/clusters/{environmentSlug}/{clusterSlug}/pools/{nodePoolId}

Request Body

application/jsonRequired

`name`string

Minimum length: 1Maximum length: 25Pattern: "^[a-z0-9-]+$"

`nodeSize`string

`autoScaling`boolean

`enableNodeAutoReplacement`boolean

`enableNodeReboots`boolean

`upgradeStrategy`string

Value in:

"REPLACE" | "INPLACE" | "INPLACE_WITHOUT_DRAIN" | "REPLACE_MINOR_INPLACE_PATCH" | "REPLACE_MINOR_INPLACE_PATCH_WITHOUT_DRAIN"

`minSize`integer

Format: "int64"

`maxSize`integer

Format: "int64"

`availabilityZone`string

`annotations`object

`labels`object

`taints`array<object>

Path Parameters

`organisationSlug`
Required
string

`environmentSlug`
Required
string

`clusterSlug`
Required
string

`nodePoolId`
Required
integer

Format: "int64"

curl -X PUT "http://localhost:8090/api/v1/orgs/string/clusters/string/string/pools/0" \
  -H "Content-Type: application/json" \
  -d '{
    "name": "string",
    "nodeSize": "string",
    "autoScaling": true,
    "enableNodeAutoReplacement": true,
    "enableNodeReboots": true,
    "upgradeStrategy": "REPLACE",
    "minSize": 0,
    "maxSize": 0,
    "availabilityZone": "string",
    "annotations": {
      "property1": "string",
      "property2": "string"
    },
    "labels": {
      "property1": "string",
      "property2": "string"
    },
    "taints": [
      {
        "key": "string",
        "value": "string",
        "effect": "string"
      }
    ]
  }'

Request was successfully processed. The response body contains the requested data.

{
  "id": 0,
  "identity": "10a80a7a-1a32-4a74-b592-aa2a4ef691c5",
  "name": "string",
  "availabilityZone": "string",
  "nodeSize": "string",
  "autoScaling": true,
  "enableNodeAutoReplacement": true,
  "enableNodeReboots": true,
  "upgradeStrategy": "REPLACE",
  "minSize": 0,
  "maxSize": 0,
  "annotations": {
    "property1": "string",
    "property2": "string"
  },
  "labels": {
    "property1": "string",
    "property2": "string"
  },
  "taints": [
    {
      "key": "string",
      "value": "string",
      "effect": "string"
    }
  ],
  "createdAt": "2019-08-24T14:15:22Z",
  "modifiedAt": "2019-08-24T14:15:22Z",
  "provisionStatus": "UNKNOWN"
}

Update node pool inside a cluster.

Request Body

namestring

nodeSizestring

autoScalingboolean

enableNodeAutoReplacementboolean

enableNodeRebootsboolean

upgradeStrategystring

minSizeinteger

maxSizeinteger

availabilityZonestring

annotationsobject

Attributes

labelsobject

Attributes

taintsarray<object>

Object 1

Path Parameters

organisationSlugRequiredstring

environmentSlugRequiredstring

clusterSlugRequiredstring

nodePoolIdRequiredinteger

Response

TypeScript

`name`string

`nodeSize`string

`autoScaling`boolean

`enableNodeAutoReplacement`boolean

`enableNodeReboots`boolean

`upgradeStrategy`string

`minSize`integer

`maxSize`integer

`availabilityZone`string

`annotations`object

`labels`object

`taints`array<object>

`organisationSlug`
Required
string

`environmentSlug`
Required
string

`clusterSlug`
Required
string

`nodePoolId`
Required
integer