Skip to main content
POST
Start an OS patch run

Authorizations

Authorization
string
header
required

Bearer authentication header of the form Bearer <token>, where <token> is your auth token.

Headers

x-ankra-organisation-id
string

PAT organisation override.

Path Parameters

cluster_id
string<uuid>
required

Body

application/json

A run's options; every member defaults to the cluster's policy.

outside_window
boolean
default:false

Start now even though the maintenance window is closed.

include_stateful_nodes
boolean | null
include_bastion
boolean | null

Response

Successful response

A started rolling patch: its operation, the host order and the hosts left out.

operation_id
string<uuid>
required
order
OSPatchHost · object[]
required
skipped
OSPatchSkippedHost · object[]
required
include_stateful_nodes
boolean
required
bastion_note
string
required
policy
OSPatchPolicy · object
required

A cluster's rolling OS patch policy.

message
string
required
hold_revert
OSPatchHoldRevert · object

The removal of the node OS update hold, with the operation that carries it or why none started.