System Administration > Lifecycle Management > Upgrade > Nodes

Associated URIs:

API Description API Path

Get upgrade task status


Get upgrade task status for the given task of the given bundle.
Both bundle_name and task_id must be provided, otherwise you
will receive a 404 NOT FOUND response.
GET /api/v1/node/upgrade
GET /api/v1/transport-nodes/<transport-node-id>/node/upgrade
GET /api/v1/cluster/<cluster-node-id>/node/upgrade

Execute upgrade task


Execute upgrade task.
POST /api/v1/node/upgrade/performtask
POST /api/v1/transport-nodes/<transport-node-id>/node/upgrade/performtask
POST /api/v1/cluster/<cluster-node-id>/node/upgrade/performtask

Get upgrade progress status


Get progress status of last upgrade step, if upgrade bundle is present.
GET /api/v1/node/upgrade/progress-status
GET /api/v1/transport-nodes/<transport-node-id>/node/upgrade/progress-status
GET /api/v1/cluster/<cluster-node-id>/node/upgrade/progress-status

Get upgrade status summary


Get status summary of node upgrade, if upgrade bundle is present.
GET /api/v1/node/upgrade/status-summary
GET /api/v1/transport-nodes/<transport-node-id>/node/upgrade/status-summary
GET /api/v1/cluster/<cluster-node-id>/node/upgrade/status-summary

Get list of nodes across all types


Get list of nodes. If request parameter component type is specified, then
all nodes for that component will be returned. If request parameter component
version is specified, then all nodes at that version will be returned.
GET /api/v1/upgrade/nodes

Get summary of nodes


Get summary of nodes, which includes node count for each type and component version.
GET /api/v1/upgrade/nodes-summary

Get the version whitelist


Get whitelist of versions for different components
GET /api/v1/upgrade/version-whitelist

Get the version whitelist for the specified component


Get whitelist of versions for a component. Component can include HOST, EDGE, CCP, MP
GET /api/v1/upgrade/version-whitelist/<component_type>

Update the version whitelist for the specified component type


Update the version whitelist for the specified component type (HOST, EDGE, CCP, MP).
PUT /api/v1/upgrade/version-whitelist/<component_type>