ReferenceREST API

Safety

REST API: Death switch status and stop. Generated from the OpenAPI document.

Death switch status

GET /v1/safety

Whether the switch is tripped, why and since when, and whether the driver confirmed all-off frames. Re-arming is never possible over the API.

Token: required · Lease: not needed

StatusMeaningBody
200Death switch statusSafety
401Missing or wrong tokenErrorBody
curl -H "Authorization: Bearer $TOKEN" http://$ROBOT:7702/v1/safety

Stop: all motors off

POST /v1/safety/stop

Trips the death switch (page with reason Api and the guard's UDP stop). Latched until re-armed on the robot. Public: needs no token and no lease. Re-arming stays naoctl rearm on the robot; see Safety model.

Token: not needed · Lease: not needed

StatusMeaningBody
200Stopped (at least one way worked)StopResult
503Neither the page nor the UDP stop could be reachedErrorBody
curl -X POST http://$ROBOT:7702/v1/safety/stop

On this page