Safeguard for Privileged Sessions On Demand Hosted - REST API Reference Guide

Use the /firmware/test endpoint as a precheck tool to trigger an upgrade test without an actual upgrade. The test reveals whether the current state of SPS is compatible with the new firmware. Possible areas where errors can occur:

• version compatibility - the new firmware is compatible with the upgrade policy

• storage space - there is enough free storage space for the upgrade?

• configuration compatibility - the current configuration settings are supported in the new firmware

• whether or not there are manually modified files on the firmware (tainted firmware)

URL

GET https://<IP-address-of-SPS>/api/firmware/test

Cookies

Operations

Operations with the /firmware/test endpoint include:

Sample request

The following command triggers a firmware upgrade test.

curl --cookie cookies https://<IP-address-of-SPS>/api/firmware/test --data '{"slot_id": <slot_id>}'

Response

There can be three possible outcomes:

• the upgrade was successful:

  {"body": "...", "key": <slot_id>}

• the upgrade was not successful due to invalid input

  • the slot_id is missing from the payload

    {"error": {"type": "IncompleteRequestBodyError"}}

  • the tested firmware slot is empty

    {"error": {"type": "ResourceNotFound"}}

• the upgrade was not successful due to an error:

  {"error": {"type": "FirmwareTestFailed"}}

The following is a sample response received when the upgrade test was successful.

For details of the meta object, see Message format.

{
     "body":
       { "test_summary": "HA check started\nHA check finished" },
     "key": "1",
     "meta": {
       "href": "/api/firmware/test",
       "parent": "/api/firmware",
       "slot": "/api/firmware/slots/1",
       "upgrade": "/api/firmware/upgrade"
     }
   }
		

The following is a sample response received when the upgrade test was not successful, because the firmware slot is empty.

{
     "error": {
       "details": {
         "mount_point": "/firmware/test",
         "resource": "3"
       },
       "message": "Resource was not found",
       "type": "ResourceNotFound"
     },
     "meta": {
       "href": "/api/firmware/test",
       "parent": "/api/firmware"
     }
   }
		

Elements of the response message body include:

/firmware/test

The following is a sample response received when the upgrade test was not successful, because the slot_id is missing from the payload.

{
     "error": {
       "details": {
         "missing_paths": [
           "slot_id"
         ]
       },
       "message": "Some paths were missing from the request body",
       "type": "IncompleteRequestBodyError"
     },
     "meta": {
       "href": "/api/firmware/test",
       "parent": "/api/firmware"
     }
   }
		

Elements of the response message body include:

The following is a sample response received when the upgrade test was not successful, because an error was found during testing.

{
     "error": {
       "details": {
         "exit_code": 1,
         "test_summary": "HA check started\nHA check failed"
       },
       "message": "The firmware test failed",
       "type": "FirmwareTestFailed"
     },
     "meta": {
       "href": "/api/firmware/test",
       "parent": "/api/firmware"
     }
   }
		

Elements of the response message body include:

HTTP response codes

For more information and a complete list of standard HTTP response codes, see Application level error codes.