Upgrade the software on a Node.

put

https://cluster.ip.address/irisservices/api/v1/public/nodes/software

Privileges: CLUSTER_CREATE

Sends a request to upgrade the software version of a Node. By default, the
Node that the request is sent to is the only one upgraded, but the user can
specify if they want to attempt to upgrade all free nodes on the network.
Before using this, you need to upload a new package to the Node you want to
upgrade by using the /public/packages endpoint.

Recent Requests

Time	Status	User Agent
Retrieving recent requests…

Loading…

Body Params

Specifies the parameters needed for a Node upgrade request.

nodeIds

array of int64s | null

Specifies a list of IDs of additional nodes to be upgraded. These must
be free Nodes present on the same local network as the Node that the
request was sent to. The ID of the Node the request was sent to should
not be included in this list. This parameter can only be specified if
upgradeAllFreeNodes is not.

nodeIds

targetSwVersion

string | null

Specifies the target software version. The node that the request is sent
to will search itself for the specified software package and if that
package is found, it will be used for the upgrade.

upgradeAllFreeNodes

boolean | null

Specifies whether or not to attempt to upgrade all free nodes which
are currently connected to the same local network as the node that the
request was sent to. This parameter can only be specified if nodeIds
is not.

upgradeSelf

boolean | null

Specifies that the node that the request is being sent to should be
upgraded. By default, this is set to true.

Responses

Language

Credentials

Header

Loading…

Response

Click Try It! to start a request and see the response here! Or choose an example:

application/json

202Success

defaultError