PUT /v2/kubernetes/clusters/{cluster_id}
To update a Kubernetes cluster, send a PUT request to
/v2/kubernetes/clusters/$K8S_CLUSTER_ID and specify one or more of the
attributes below.
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 |
|---|---|---|---|
auto_upgrade |
Boolean | No |
A boolean value indicating whether the cluster will be automatically upgraded to new patch releases during its maintenance window. Default value: false |
cluster_autoscaler_configuration |
Object | No |
An object specifying custom cluster autoscaler configuration. |
cluster_autoscaler_configuration.scale_down_utilization_threshold |
Number | No |
Used to customize when cluster autoscaler scales down non-empty nodes by setting the node utilization threshold. |
cluster_autoscaler_configuration.expanders[] |
Array | No |
Customizes expanders used by cluster-autoscaler.
The autoscaler will apply each expander from the provided list to narrow down the selection of node types created to scale up,
until either a single node type is left, or the list of expanders is exhausted.
If this flag is unset, autoscaler will use its default expander Available expanders:
|
cluster_autoscaler_configuration.scale_down_unneeded_time |
String | No |
Used to customize how long a node is unneeded before being scaled down. |
name |
String | Yes |
A human-readable name for a Kubernetes cluster. |
routing_agent |
Object | No |
An object specifying whether the routing-agent component should be enabled for the Kubernetes cluster. |
routing_agent.enabled |
Boolean | No |
Indicates whether the routing-agent component is enabled. |
tags[] |
Array | No |
An array of tags applied to the Kubernetes cluster. All clusters are automatically tagged |
surge_upgrade |
Boolean | No |
A boolean value indicating whether surge upgrade is enabled/disabled for the cluster. Surge upgrade makes cluster upgrades fast and reliable by bringing up new nodes before destroying the outdated nodes. Default value: false |
control_plane_firewall |
Object | No |
An object specifying the control plane firewall for the Kubernetes cluster. Control plane firewall is in early availability (invite only). |
control_plane_firewall.allowed_addresses[] |
Array | No |
An array of public addresses (IPv4 or CIDR) allowed to access the control plane. |
control_plane_firewall.enabled |
Boolean | No |
Indicates whether the control plane firewall is enabled. |
maintenance_policy |
Object | No |
An object specifying the maintenance window policy for the Kubernetes cluster. |
maintenance_policy.day |
String | No |
The day of the maintenance window policy. May be one of Possible values:
|
maintenance_policy.start_time |
String | No |
The start time in UTC of the maintenance window policy in 24-hour clock format / HH:MM notation (e.g., |
maintenance_policy.duration |
String | No |
The duration of the maintenance window policy in human-readable format. |
ha |
Boolean | No |
A boolean value indicating whether the control plane is run in a highly available configuration in the cluster. Highly available control planes incur less downtime. The property cannot be disabled. Default value: false |
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.