Skip to content

Signing in & roles ​

If ratavyr has API tokens configured, every endpoint except GET /api/health and GET /api/info needs one. The UI learns this from /api/info (auth_required) and your role from /api/session.

Entering a token ​

Enter the token in the banner that appears, or under Settings.

OptionStored inLifetime
defaultsessionStorageForgotten when the tab closes
remember on this devicelocalStorageKept until you clear it

Both use the key motioncore.api_token. Only tick "remember" on a device you trust.

How the token is used ​

  • REST requests send Authorization: Bearer <token>.
  • Before every WebSocket connect and reconnect, the UI exchanges the token for a single-use, 30-second ticket (POST /api/ws-tickets) and connects with ?ticket=…. The token never appears in a URL.

Roles ​

RoleCan
viewerWatch everything; Stop and E-STOP
operatorEverything a viewer can, plus Enable / Disable, Reset fault, jog, home, move, firmware builds
adminEverything, including flashing firmware

Controls your role may not use are disabled with an explanation. The server enforces the same rules regardless of what the UI shows. Tokens and roles are configured on the gateway: ratavyr: authentication.

Errors ​

  • Any 401 response brings back the sign-in banner.
  • A 403 is shown as a failed action.

Older servers ​

With ratavyr older than 0.3 (no /api/session or /api/ws-tickets), the UI still works: your permissions are unknown, so controls stay enabled and the server decides, and the WebSocket falls back to the deprecated ?access_token=.

Part of MotionCore. The on-screen E-STOP is a software stop — it never replaces a hardware E-stop circuit.