Noteworthy API changes¶

This is a summary of noteworthy API changes. For more details, see the main Change log.

The general documentation page for API related aspects is here.

2026-10-22: GET /api/vehicles/{vehicle}/status: new mission.timeoutMinutes and mission.timeoutAt
2026-10-21: GET /api/vconfig only uses the directory where the vehicle's Vehicle.name is declared (no longer any directory whose name ends with the vehicle name); POST /api/git/sync and POST /api/git/checkout include a vehicle discovery report under vehicles for the config clone; new GET /api/git/vehicles with that report for any git reference
2026-10-19: New GET /api/dataLink/requests (operators); GET /api/ping keeps the last hour, with no limit maximum; websocket VehicleConnected now with upload
2026-10-17: New GET /q/info to expose TethysDash application info, including last commit hash and time
2026-10-17: GET /api/vconfig: new fromPersistedCfg for settings from the latest listing of Data/persisted.cfg
2026-10-16: GET /api/commands excludes the schedule syntaxes handled by TethysDash, unless all=y
2026-10-14: New GET /api/git/status with status for both clones
2026-10-08: GET /api/events and websocket event-array: new recordedUnixTime/recordedIsoTime, when the event was stored
2026-10-06: New GET /api/vehicles/{vehicle}/status (preview); see Vehicle status
2026-10-01: New optional schedRepeat parameter for POST /commands and GET /commands/preview
2026-09-29: Websocket: ResourceUpdated now also for resources "commandQueue", "deployment" and "document"
2026-09-28: GET /commands/queue entries now with dispatched; canceling an already sent part is refused unless force=true in DELETE /commands/queue
2026-09-25: Websocket: New ResourceUpdated notification (for now, for the station and polygon lists), with originClientId if the request had an X-Client-Id header
2026-09-21: External documents: POST/PUT /api/documents/external; GET /api/documents includes them only with includeExternal=y
2026-09-08: Various security enhancements related to auth tokens and API Keys
2026-08-28: Carto base layers now require an API Key
2026-08-25: GET /api/vpos now with navigatingToWaypoints and iridiumPositions; GET /api/events now with Lat/Lon/CEPradius reported by Iridium in sbdReceive events whose email has no attachment
2026-08-25: GET /data root listing will be restricted if data.restrictRootListing = true in TethysDash.conf
2026-08-17: /dataLink, the endpoint used by the LRAUV, has been migrated to modern framework
2026-08-17: extraEmails removed in POST api/user (registration) and PUT api/user (update)
2026-07-21: GET /api/vpos: Reached waypoints are now populated again
2026-07-06: New verification code step when adding/editing notification recipient
2026-06-23: GET /api/events: All parameters are now documented in the OpenAPI spec
2026-06-19: GET api/data/{variableName} endpoint now with a new step parameter
2026-06-01: Websocket: Legacy /ws/{token} endpoint has been removed
2026-05-13: Websocket: A more secure endpoint at /ws
2026-04-28: Endpoint commands/queue is now documented in this OpenAPI spec
2025-10-21: Added GET git/checkedOutBranches
2024-06-24: Added via=cellsat option for POST /commands
2024-06-19: New optional parameters via and timeout for POST /commands
2024-02-13: Fixes regarding the handling of omitted tag parameter for GET /git/missions, GET /wp, GET /git/missionList
2023-04-05: GET /info/vehicles deprecated
2023-03-12: New /api/hotspot endpoint
2023-02-21: New /data/<variableName> endpoint
2022-10-07: New GET /data operation to get data associated to most recent dataProcessed event
2022-08-10: New GET /git/missionList operation to get complete list of missions for a given git reference
2022-07-12: New /user/picoc, /user/byrole endpoints
2022-06-16: More revision and documentation of existing operations
2022-06-13: GET /info/vehicles added. GET /commands/script with new parameter gitRef