Authentication

!!! info "Coming soon" The Rover Nexus REST API is not yet available. This page describes the planned shape and may change. To integrate today, use the Zenoh messaging surface (primary) or the ROS 2 bridge.

All Rover Nexus REST API requests are authenticated and sent over HTTPS.

Overview

The API uses account-based authentication. Each request must carry a credential (an API key or token) that identifies your account and determines what organizations, fleets, and robots you can access. Requests without a valid credential are rejected.

The exact credential type and supported authentication mechanisms are coming soon.

Creating a key

API credentials are issued from your Rover Nexus account.

Details on where and how to create, name, rotate, and revoke API keys are coming soon.

Using a key

Include your credential on every request as an HTTP header over HTTPS. The exact header name and value format are coming soon.

Scopes and permissions

Access is bounded by the permissions of the account the credential belongs to. A credential can only act on the organizations and fleets that account can reach, and only perform the operations its role allows (for example, read-only versus dispatch).

The available scopes and permission levels for API credentials, and how they map to the actions in this reference, are coming soon.

Errors

Authentication failure responses, including status codes and body formats, are coming soon.