Configuration

Checking

This endpoint allows you to force the Robot to check if a new update is available to be installed.

Note that only administrators can use this endpoint.

Request

PUT /api/v1/config/update/check

Payload

None

Reply

It will return an update plan, which will describe the different updates available for your Robot in the order they need to be applied. In the case of a major version change (e.g. 3.0.0 to 4.0.0), we usually ask users to upgrade manually to the breaking version (e.g. 4.0.0) before being able to apply the latest version (e.g. 4.2.0). Here is an example of a such a plan for a Robot currently using 3.2.0 and wanting to upgrade to 4.2.0, it will first need to apply 4.0.0 then 4.2.0.

{
  "updates": [
    {
      "version": "4.0.0",
      "changelogs": [
        {
          "version": "4.0.0",
          "content": "Added 123"
        }
      ]
    },
    {
      "version": "4.2.0",
      "changelogs": [
        {
          "version": "4.2.0",
          "content": "Added XYZ"
        },
        {
          "version": "4.1.0",
          "content": "Added ABC"
        }
      ]
    }
  ]
}

or an error.

Applying

This endpoint allows you to install an update on the Robot.

Note that this endpoint requires the Robot lock to be acquired because you are affecting the physical Robot. Moreover, only administrators can install updates.

Request

POST /api/v1/config/update/apply

Payload

{
  "version": "4.2.0"
}

Reply

None (204) or an error.

Manual updates (deprecated)

Updating

This endpoint allows you to install an update on the Robot which you have already downloaded.

Note that this endpoint requires the Robot lock to be acquired because you are affecting the physical Robot. Moreover, only administrators can install updates.

Request

POST /api/v1/config/update

Payload

The raw update package as downloaded from our website.

Reply

{
  "updating": true
}

or an error.