ReferenceREST API

Robot

REST API: Identity and versions. Generated from the OpenAPI document.

Hardware readings

GET /v1/hardware

Head power and temperature, CPU temperature, the fan and board versions, about once a second. Only on the real robot (503 in the simulator and the mock robot). The devices behind these values are on Hardware reference.

Token: required · Lease: not needed

StatusMeaningBody
200The latest readingsHardware
401Missing or wrong tokenErrorBody
503The robot runtime has not reported yetErrorBody
curl -H "Authorization: Bearer $TOKEN" http://$ROBOT:7702/v1/hardware

Robot identity and versions

GET /v1/robot

Serial numbers, the software version and the ports of the robot's interfaces.

Token: required · Lease: not needed

StatusMeaningBody
200Identity and versionsRobot
401Missing or wrong tokenErrorBody
curl -H "Authorization: Bearer $TOKEN" http://$ROBOT:7702/v1/robot

On this page