POST /v2/kubernetes/clusters/{cluster_id}/node_pools
To add an additional node pool to a Kubernetes clusters, send a POST request
to /v2/kubernetes/clusters/$K8S_CLUSTER_ID/node_pools
with the following
attributes.
Servers
- https://api.digitalocean.com
Path parameters
Name | Type | Required | Description |
---|---|---|---|
cluster_id |
String | Yes |
A unique ID that can be used to reference a Kubernetes cluster. |
Request headers
Name | Type | Required | Description |
---|---|---|---|
Content-Type |
String | Yes |
The media type of the request body.
Default value: "application/json" |
Request body fields
Name | Type | Required | Description |
---|---|---|---|
id |
String | No |
A unique ID that can be used to identify and reference a specific node pool. |
size |
String | Yes |
The slug identifier for the type of Droplet used as workers in the node pool. |
name |
String | Yes |
A human-readable name for the node pool. |
count |
Integer | Yes |
The number of Droplet instances in the node pool. |
min_nodes |
Integer | No |
The minimum number of nodes that this node pool can be auto-scaled to. The value will be |
labels |
Object | No |
An object of key/value mappings specifying labels to apply to all nodes in a pool. Labels will automatically be applied to all existing nodes and any subsequent nodes added to the pool. Note that when a label is removed, it is not deleted from the nodes in the pool. |
max_nodes |
Integer | No |
The maximum number of nodes that this node pool can be auto-scaled to. The value will be |
nodes[] |
Array | No |
An object specifying the details of a specific worker node in a node pool. |
nodes[].id |
String | No |
A unique ID that can be used to identify and reference the node. |
nodes[].name |
String | No |
An automatically generated, human-readable name for the node. |
nodes[].droplet_id |
String | No |
The ID of the Droplet used for the worker node. |
nodes[].status |
Object | No |
An object containing a |
nodes[].status.state |
String | No |
A string indicating the current status of the node. Possible values:
|
nodes[].created_at |
String | No |
A time value given in ISO8601 combined date and time format that represents when the node was created. |
nodes[].updated_at |
String | No |
A time value given in ISO8601 combined date and time format that represents when the node was last updated. |
tags[] |
Array | No |
An array containing the tags applied to the node pool. All node pools are automatically tagged |
auto_scale |
Boolean | No |
A boolean value indicating whether auto-scaling is enabled for this node pool. |
taints[] |
Array | No |
An array of taints to apply to all nodes in a pool. Taints will automatically be applied to all existing nodes and any subsequent nodes added to the pool. When a taint is removed, it is deleted from all nodes in the pool. |
taints[].effect |
String | No |
How the node reacts to pods that it won't tolerate. Available effect values are Possible values:
|
taints[].key |
String | No |
An arbitrary string. The |
taints[].value |
String | No |
An arbitrary string. The |
How to start integrating
- Add HTTP Task to your workflow definition.
- Search for the API you want to integrate with and click on the name.
- This loads the API reference documentation and prepares the Http request settings.
- Click Test request to test run your request to the API and see the API's response.