v1

latestOpenAPI 3.0.0Apache 2.02026-07-17143274803.9 KB

clusters

Report to Pipeline the progress of the bootstrapping of a new node (to be called by PKE installer)

post/api/v1/orgs/{orgId}/clusters/{id}/pke/status

orgIdinteger required

Organization identifier

idinteger required

Cluster identifier

namestring

name of node

nodePoolstring

name of nodepool

ipstring

ip address of node (where the other nodes can reach it)

messagestring

detailed description about the current bootstrapping status (including the cause of the failure)

phasestring

the current phase of the bootstrap process

finalboolean

if this is the final status report, that describes the conclusion of the whole process

status'running' | 'failed' | 'finished' | 'canceled'

timestampstring date-time nullable

exact time of event

processIdstring

ID of the process registered earlier (register new process if empty)

{
  "name": "my-node",
  "nodePool": "master",
  "ip": "127.0.0.1",
  "message": "installing docker daemon",
  "phase": "pre-flight"
}

Success

processIdstring

ID of the registered process

{
  "processId": "processId"
}