POST
/v2/kubernetes/clusters/{cluster_id}/node_pools/{node_pool_id}/recycleDeprecatedRecycle a Kubernetes node pool
Submits a request to recycle nodes in a Kubernetes node pool. This operation is closing down and will be removed on an unspecified date; use DELETE /v2/kubernetes/clusters/{cluster_id}/node_pools/{node_pool_id}/nodes/{node_id} to remove an individual node instead.
- IdempotentThe SDK sends
Idempotency-Key, so a retried request is only applied once.
cluster_idstringrequired
The UUID of the Kubernetes cluster containing the node pool.
node_pool_idstringrequired
The UUID of the Kubernetes node pool to recycle.
Request body for the node pool recycle operation.
nodesarray<string>optional
An array of node identifiers to recycle.
202Returns a response confirming that the request was accepted for processing; it does not indicate whether the operation succeeded.
401Returned when authentication fails because the credentials are invalid.
idstringrequired
A short identifier corresponding to the HTTP status code returned. For example, the ID for a response returning a 404 status code would be "not_found."
messagestringrequired
A message providing additional information about the error, including details to help resolve it when possible.
request_idstringoptional
Optionally, some endpoints may include a request ID that should be provided when reporting bugs or opening support tickets to help identify the issue.
404Returned when the requested resource is not found.
idstringrequired
A short identifier corresponding to the HTTP status code returned. For example, the ID for a response returning a 404 status code would be "not_found."
messagestringrequired
A message providing additional information about the error, including details to help resolve it when possible.
request_idstringoptional
Optionally, some endpoints may include a request ID that should be provided when reporting bugs or opening support tickets to help identify the issue.
429Returned when the API rate limit has been exceeded.
idstringrequired
A short identifier corresponding to the HTTP status code returned. For example, the ID for a response returning a 404 status code would be "not_found."
messagestringrequired
A message providing additional information about the error, including details to help resolve it when possible.
request_idstringoptional
Optionally, some endpoints may include a request ID that should be provided when reporting bugs or opening support tickets to help identify the issue.
500Returned when a server error occurs.
idstringrequired
A short identifier corresponding to the HTTP status code returned. For example, the ID for a response returning a 404 status code would be "not_found."
messagestringrequired
A message providing additional information about the error, including details to help resolve it when possible.
request_idstringoptional
Optionally, some endpoints may include a request ID that should be provided when reporting bugs or opening support tickets to help identify the issue.
defaultReturned when an unexpected error occurs.
idstringrequired
A short identifier corresponding to the HTTP status code returned. For example, the ID for a response returning a 404 status code would be "not_found."
messagestringrequired
A message providing additional information about the error, including details to help resolve it when possible.
request_idstringoptional
Optionally, some endpoints may include a request ID that should be provided when reporting bugs or opening support tickets to help identify the issue.
Error handling
A 401 is returned when credentials are invalid, and a 404 is returned when the cluster or node pool is not found. A 429 is returned when the API rate limit is exceeded, and a 500 is returned when a server error occurs. The cluster_id and node_pool_id path parameters must be UUIDs; nodes is an array of strings.