kubernetes

Drain a Kubernetes node

Drain a Kubernetes node by safely evicting all pods from the node, preparing it for maintenance or removal Access policy: authenticated

post/kubernetes/{id}/nodes/{name}/drain

Request

Base URL
/api (relative, and the document was published on a file host, not at the API’s origin)
URL
/api/kubernetes/{id}/nodes/{name}/drain
Auth
API key in header X-API-KEY and API key in header Authorization

idinteger required

Environment(Endpoint) identifier

namestring required

Name of the node to drain

DeleteEmptyDirDataboolean

DeleteEmptyDirData allows eviction of pods using emptyDir volumes, whose data is lost once the pod is deleted.

DisableEvictionboolean

DisableEviction forces the use of direct pod deletion instead of the eviction API, ignoring any configured PodDisruptionBudgets.

Forceboolean

Force allows deletion of standalone pods not managed by a controller.

GracePeriodSecondsinteger

GracePeriodSeconds overrides each pod's termination grace period. -1 uses the pod's own grace period.

IgnoreDaemonSetsboolean

IgnoreDaemonSets skips DaemonSet-managed pods, which would otherwise block the drain.

TimeoutSecondsinteger

TimeoutSeconds is the overall time to wait for the drain to complete. Defaults to 60 when omitted.

{
  "DeleteEmptyDirData": true,
  "GracePeriodSeconds": -1,
  "IgnoreDaemonSets": true,
  "TimeoutSeconds": 60
}

Success