Skip to content

Missions

!!! 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.

A mission is a unit of work you define once and then dispatch or schedule to robots, tracking each run as it executes.

What it represents

Missions have three related parts:

  • Templates — reusable definitions of the work to be done, planned ahead of time.
  • Dispatch and schedule — assigning a mission to one or more robots, either immediately or on a schedule, optionally recurring.
  • Runs — individual executions of a mission, with status that updates as the robot works (for example, ready, running, completed, or error).

Base URL

The API base URL for mission endpoints is coming soon.

Authentication

All requests require a valid credential. See Authentication.

Endpoints

The mission resource spans templates, scheduling/dispatch, and runs. Exact paths and payloads are not yet finalized.

Templates

Operation Description
List List mission templates
Get Retrieve a single template
Create Create a mission template
Update Update a template
Delete Remove a template

Dispatch and schedule

Operation Description
Dispatch Send a mission to one or more robots now
Schedule Schedule a mission (one-time or recurring)
List schedules List scheduled missions
Cancel Cancel a scheduled mission

Runs

Operation Description
List List mission runs
Get Retrieve a single run and its status

Exact paths, methods, and parameters are coming soon.

Errors and pagination

The error response format and the pagination scheme used by list endpoints are coming soon.