Skip to main content
POST
Apply the node OS update hold

Authorizations

Authorization
string
header
required

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

Path Parameters

cluster_id
string<uuid>
required

Body

application/json
node_ids
string<uuid>[]

The nodes to act on; exclusive with all_nodes.

Maximum array length: 100
all_nodes
boolean
default:false

Act on every node of the cluster.

include_bastion
boolean
default:false

Act on the bastion as well.

revert
boolean
default:false

Remove the hold instead of writing it.

Response

Successful response

operation_id
string<uuid>
required
step_id
string<uuid>
required
resource_id
string
required

The bastion resource the job was dispatched against.

job_name
string
required
status
string
required
completed
boolean
required

False when the wait budget elapsed first; poll operation_id for the report.

health
object
required

The platform's own bastion health view at dispatch time.

report
object

The job's per-host outcome, present once it completed.

error_excerpt
string