Skip to main content
POST
Plan OS patches

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

Response

Successful response

The dry run's answer: each host's pending upgrades, the order a run would take, and the hosts it would skip.

operation_id
string<uuid>
required
completed
boolean
required

False when the hosts had not all reported within the wait; poll the operation.

hosts
OSPatchHostPlan · object[]
required
run_order
string[]
required

Host names in the order a run would patch them.

skipped
OSPatchSkippedHost · object[]
required
policy
OSPatchPolicy · object
required

A cluster's rolling OS patch policy.

message
string
required
summary
OSPatchPlanSummary · object

Counts across the hosts of a dry run.