TOS Version Migration

Get TOS migration status/progress

get/appliancemigrations

View the status for the latest TOS migration task for each appliance.

Request
query Parameters
applianceIds
required
Array of integers <int64> [ 1 .. 50 ] items

Appliance IDs in an array (max is 50).

Responses
200

OK

400

Bad Request

401

Unauthorized

403

Forbidden

500

Internal Server Error

Response samples
application/json
{
  • "statuses": [
    ]
}

Initiate a TOS migration plan for an appliance

post/appliancemigrations

Send an initiated TOS migration request to an appliance.

Use TOS migration actions to upgrade or rollback appliances.

Request
Request Body schema: application/json
action
required
string

The TOS migration task action.

applianceId
required
integer <int64>

The appliance ID.

Responses
202

Accepted

400

Bad Request

401

Unauthorized

403

Forbidden

409

The request to migrate the appliance was rejected because of a conflict.

For example, the appliance could be scheduled for a reboot or could be completing a different TOS migration.

500

Internal Server Error

Request samples
application/json
{
  • "applianceId": 0,
  • "action": "upgrade|rollback"
}
Response samples
application/json
{
  • "message": "string"
}

Get the available TOS migration versions.

get/migrationversions

View the available upgrade or rollback TOS versions for an appliance.

Request
query Parameters
applianceId
required
integer <int64>
Responses
200

OK

400

Bad Request

401

Unauthorized

403

Forbidden

500

Internal Server Error

Response samples
application/json
{
  • "baseVersion": "2020.12.0.10001",
  • "state": "upToDate|outOfDate|unknown",
  • "permission": "write|read",
  • "upgrade": "2020.12.0.10001",
  • "rollback": "2020.12.0.10001"
}