servers/update

1 minute read.

Last Modified 2021-02-04 11:38 EST

Namespace	Name	Admin Only	Log Summary	Generates Event	Version Added
servers	update	no	no	no	1.1

Description

Have a NAS start performing updates. The system will automatically reboot to finish the update procedures. These updates will only occur on the currently-selected update train. Switching update trains must be performed on the NAS itself.

Update status is reported via the servers/list API output.

Input Arguments

Required: “id” (string or JSON Array of strings) : System ID’s for the systems to start upgrading.
Optional:
- none ({})

Request Example Arguments

ARGUMENTS ONLY: See the basics of API requests for additional formatting information.

{
  "id" : "server_id_1"
}

Reply Example

Example Reply Arguments (success):

{
  "result" : "success",
  "starting_updates" : ["server_id_1"],
  "unsupported" : []
}

Example Reply Arguments (incompatible version of NAS):

{
  "result" : "failure"
  "unsupported" : ["server_id_1"]
}

Events

This API call does not emit any middleware events.

Log Summary

This API call does not generate a detailed log summary item