> For clean Markdown of any page, append .md to the page URL. > For a complete documentation index, see https://docs.ouster.com/sensor-docs/firmware/3.2/api-reference/llms.txt. > For AI client integration (Claude Code, Cursor, etc.), connect to the MCP server at https://docs.ouster.com/sensor-docs/_mcp/server. # API Reference ## API Docs - [Query the system for information about current and past alerts](https://docs.ouster.com/sensor-docs/firmware/3.2/api-reference/ouster-http-api/alerts-diagnostics-and-telemetry/get-alerts.md): Ouster HTTP API > Alerts Diagnostics and Telemetry - [Get the diagnostics files](https://docs.ouster.com/sensor-docs/firmware/3.2/api-reference/ouster-http-api/alerts-diagnostics-and-telemetry/get-diagnostics-dump.md): Ouster HTTP API > Alerts Diagnostics and Telemetry - [Get the telemetry information](https://docs.ouster.com/sensor-docs/firmware/3.2/api-reference/ouster-http-api/alerts-diagnostics-and-telemetry/get-telemetry.md): Ouster HTTP API > Alerts Diagnostics and Telemetry - [Get information](https://docs.ouster.com/sensor-docs/firmware/3.2/api-reference/ouster-http-api/sensor-metadata/get-sensor-info.md): Ouster HTTP API > Sensor Metadata - [Get the lidar data format](https://docs.ouster.com/sensor-docs/firmware/3.2/api-reference/ouster-http-api/sensor-metadata/get-lidar-data-format.md): Ouster HTTP API > Sensor Metadata - [Get the IMU data format](https://docs.ouster.com/sensor-docs/firmware/3.2/api-reference/ouster-http-api/sensor-metadata/get-imu-data-format.md): Ouster HTTP API > Sensor Metadata - [Get Zone Monitor metadata](https://docs.ouster.com/sensor-docs/firmware/3.2/api-reference/ouster-http-api/sensor-metadata/get-zone-monitor-metadata.md): Ouster HTTP API > Sensor Metadata - [Get the beam intrinsics](https://docs.ouster.com/sensor-docs/firmware/3.2/api-reference/ouster-http-api/sensor-metadata/get-beam-intrinsics.md): Ouster HTTP API > Sensor Metadata - [Get the IMU intrinsics](https://docs.ouster.com/sensor-docs/firmware/3.2/api-reference/ouster-http-api/sensor-metadata/get-imu-intrinsics.md): Ouster HTTP API > Sensor Metadata - [Get the lidar intrinsics](https://docs.ouster.com/sensor-docs/firmware/3.2/api-reference/ouster-http-api/sensor-metadata/get-lidar-intrinsics.md): Ouster HTTP API > Sensor Metadata - [Get the calibration status](https://docs.ouster.com/sensor-docs/firmware/3.2/api-reference/ouster-http-api/sensor-metadata/get-calibration-status.md): Ouster HTTP API > Sensor Metadata - [Get a single configuration parameter](https://docs.ouster.com/sensor-docs/firmware/3.2/api-reference/ouster-http-api/sensor-metadata/get-config-single.md): Ouster HTTP API > Sensor Metadata - [Set a single configuration parameter](https://docs.ouster.com/sensor-docs/firmware/3.2/api-reference/ouster-http-api/sensor-metadata/put-config-single.md): Ouster HTTP API > Sensor Metadata - [Get all configuration parameters](https://docs.ouster.com/sensor-docs/firmware/3.2/api-reference/ouster-http-api/sensor-metadata/get-config.md): Ouster HTTP API > Sensor Metadata - [Set configuration parameters](https://docs.ouster.com/sensor-docs/firmware/3.2/api-reference/ouster-http-api/sensor-metadata/post-config.md): Ouster HTTP API > Sensor Metadata - [Reset configuration](https://docs.ouster.com/sensor-docs/firmware/3.2/api-reference/ouster-http-api/sensor-metadata/delete-config.md): Ouster HTTP API > Sensor Metadata - [Get the metadata information](https://docs.ouster.com/sensor-docs/firmware/3.2/api-reference/ouster-http-api/sensor-metadata/get-metadata.md): Ouster HTTP API > Sensor Metadata - [Get all Multipurpose IO (MIO) channel states](https://docs.ouster.com/sensor-docs/firmware/3.2/api-reference/ouster-http-api/sensor-metadata/get-mio.md): Ouster HTTP API > Sensor Metadata - [Get specific Multipurpose IO (MIO) channel state](https://docs.ouster.com/sensor-docs/firmware/3.2/api-reference/ouster-http-api/sensor-metadata/get-mio-channel.md): Ouster HTTP API > Sensor Metadata - [Restarts the sensor](https://docs.ouster.com/sensor-docs/firmware/3.2/api-reference/ouster-http-api/system/post-restart.md): Ouster HTTP API > System - [Overview of the firmware](https://docs.ouster.com/sensor-docs/firmware/3.2/api-reference/ouster-http-api/system/get-firmware.md): Ouster HTTP API > System - [Update the firmware](https://docs.ouster.com/sensor-docs/firmware/3.2/api-reference/ouster-http-api/system/post-firmware.md): Ouster HTTP API > System - [Get the system network configuration](https://docs.ouster.com/sensor-docs/firmware/3.2/api-reference/ouster-http-api/system/get-network.md): Ouster HTTP API > System - [Get the IPv4 network configuration](https://docs.ouster.com/sensor-docs/firmware/3.2/api-reference/ouster-http-api/system/get-network-i-pv-4.md): Ouster HTTP API > System - [Get the current IPv4 static IP address override](https://docs.ouster.com/sensor-docs/firmware/3.2/api-reference/ouster-http-api/system/get-network-i-pv-4-override.md): Ouster HTTP API > System - [Override a static IP address](https://docs.ouster.com/sensor-docs/firmware/3.2/api-reference/ouster-http-api/system/put-network-i-pv-4-override.md): Ouster HTTP API > System - [Delete the static IP override](https://docs.ouster.com/sensor-docs/firmware/3.2/api-reference/ouster-http-api/system/delete-network-i-pv-4-override.md): Ouster HTTP API > System - [Get T1 ethernet speed override](https://docs.ouster.com/sensor-docs/firmware/3.2/api-reference/ouster-http-api/system/get-network-speed-override.md): Ouster HTTP API > System - [Set T1 ethernet speed override](https://docs.ouster.com/sensor-docs/firmware/3.2/api-reference/ouster-http-api/system/put-network-speed-override.md): Ouster HTTP API > System - [Reset the T1 ethernet speed override](https://docs.ouster.com/sensor-docs/firmware/3.2/api-reference/ouster-http-api/system/delete-network-speed-override.md): Ouster HTTP API > System - [Get the system time configuration](https://docs.ouster.com/sensor-docs/firmware/3.2/api-reference/ouster-http-api/time/get-time.md): Ouster HTTP API > Time - [Get the time information](https://docs.ouster.com/sensor-docs/firmware/3.2/api-reference/ouster-http-api/time/get-time-sensor.md): Ouster HTTP API > Time - [Get the operating system time status](https://docs.ouster.com/sensor-docs/firmware/3.2/api-reference/ouster-http-api/time/get-time-system.md): Ouster HTTP API > Time - [Get the status of the PTP daemon](https://docs.ouster.com/sensor-docs/firmware/3.2/api-reference/ouster-http-api/time/get-time-ptp.md): Ouster HTTP API > Time - [Get the active PTP profile](https://docs.ouster.com/sensor-docs/firmware/3.2/api-reference/ouster-http-api/time/get-time-ptp-profile.md): Ouster HTTP API > Time - [Change the PTP profile](https://docs.ouster.com/sensor-docs/firmware/3.2/api-reference/ouster-http-api/time/put-time-ptp-profile.md): Ouster HTTP API > Time - [Reset PTP profile to default](https://docs.ouster.com/sensor-docs/firmware/3.2/api-reference/ouster-http-api/time/delete-time-ptp-profile.md): Ouster HTTP API > Time - [Retrieve user-data field](https://docs.ouster.com/sensor-docs/firmware/3.2/api-reference/ouster-http-api/user-data/get-user-data.md): Ouster HTTP API > User Data - [Puts custom content in user-data field.](https://docs.ouster.com/sensor-docs/firmware/3.2/api-reference/ouster-http-api/user-data/put-user-data.md): Ouster HTTP API > User Data - [Deletes the current user-data field](https://docs.ouster.com/sensor-docs/firmware/3.2/api-reference/ouster-http-api/user-data/delete-user-data.md): Ouster HTTP API > User Data - [Get Zone Monitor status](https://docs.ouster.com/sensor-docs/firmware/3.2/api-reference/ouster-http-api/zone-monitor/get-zone-monitor-status.md): Ouster HTTP API > Zone Monitor - [Get live zone IDs](https://docs.ouster.com/sensor-docs/firmware/3.2/api-reference/ouster-http-api/zone-monitor/get-live-zone-i-ds.md): Ouster HTTP API > Zone Monitor - [Set live zone IDs](https://docs.ouster.com/sensor-docs/firmware/3.2/api-reference/ouster-http-api/zone-monitor/set-live-zone-i-ds.md): Ouster HTTP API > Zone Monitor - [Get zone set configuration metadata](https://docs.ouster.com/sensor-docs/firmware/3.2/api-reference/ouster-http-api/zone-monitor/get-zone-set-configuration-metadata.md): Ouster HTTP API > Zone Monitor - [Get available zone IDs for a zone set](https://docs.ouster.com/sensor-docs/firmware/3.2/api-reference/ouster-http-api/zone-monitor/get-available-zone-i-ds-for-a-zone-set.md): Ouster HTTP API > Zone Monitor - [Get zone configuration as a ZIP file](https://docs.ouster.com/sensor-docs/firmware/3.2/api-reference/ouster-http-api/zone-monitor/get-zone-configuration-as-a-zip-file.md): Ouster HTTP API > Zone Monitor - [Get zone set configuration hash](https://docs.ouster.com/sensor-docs/firmware/3.2/api-reference/ouster-http-api/zone-monitor/get-zone-set-configuration-hash.md): Ouster HTTP API > Zone Monitor - [Validate zone set configuration](https://docs.ouster.com/sensor-docs/firmware/3.2/api-reference/ouster-http-api/zone-monitor/validate-zone-set-configuration.md): Ouster HTTP API > Zone Monitor - [Get render time estimate for zone set](https://docs.ouster.com/sensor-docs/firmware/3.2/api-reference/ouster-http-api/zone-monitor/get-render-time-estimate-for-zone-set.md): Ouster HTTP API > Zone Monitor - [Get zone set label](https://docs.ouster.com/sensor-docs/firmware/3.2/api-reference/ouster-http-api/zone-monitor/get-zone-set-label.md): Ouster HTTP API > Zone Monitor - [Get sensor-to-body transform configuration](https://docs.ouster.com/sensor-docs/firmware/3.2/api-reference/ouster-http-api/zone-monitor/get-sensor-to-body-transform-configuration.md): Ouster HTTP API > Zone Monitor - [Get zone set version information](https://docs.ouster.com/sensor-docs/firmware/3.2/api-reference/ouster-http-api/zone-monitor/get-zone-set-version-information.md): Ouster HTTP API > Zone Monitor - [Get configuration for a zone](https://docs.ouster.com/sensor-docs/firmware/3.2/api-reference/ouster-http-api/zone-monitor/get-configuration-for-a-zone.md): Ouster HTTP API > Zone Monitor - [Get STL file for a zone](https://docs.ouster.com/sensor-docs/firmware/3.2/api-reference/ouster-http-api/zone-monitor/get-stl-file-for-a-zone.md): Ouster HTTP API > Zone Monitor - [Get ZRB file for a zone](https://docs.ouster.com/sensor-docs/firmware/3.2/api-reference/ouster-http-api/zone-monitor/get-zrb-file-for-a-zone.md): Ouster HTTP API > Zone Monitor - [Get zone label](https://docs.ouster.com/sensor-docs/firmware/3.2/api-reference/ouster-http-api/zone-monitor/get-zone-label.md): Ouster HTTP API > Zone Monitor - [Get a specific configuration parameter for a zone](https://docs.ouster.com/sensor-docs/firmware/3.2/api-reference/ouster-http-api/zone-monitor/get-a-specific-configuration-parameter-for-a-zone.md): Ouster HTTP API > Zone Monitor - [Get power-on live zone IDs](https://docs.ouster.com/sensor-docs/firmware/3.2/api-reference/ouster-http-api/zone-monitor/get-power-on-live-zone-i-ds.md): Ouster HTTP API > Zone Monitor - [Get hash for a zone file](https://docs.ouster.com/sensor-docs/firmware/3.2/api-reference/ouster-http-api/zone-monitor/get-hash-for-a-zone-file.md): Ouster HTTP API > Zone Monitor - [Get STL coordinate frame for a zone](https://docs.ouster.com/sensor-docs/firmware/3.2/api-reference/ouster-http-api/zone-monitor/get-stl-coordinate-frame-for-a-zone.md): Ouster HTTP API > Zone Monitor - [Get STL filename for a zone](https://docs.ouster.com/sensor-docs/firmware/3.2/api-reference/ouster-http-api/zone-monitor/get-stl-filename-for-a-zone.md): Ouster HTTP API > Zone Monitor - [Apply staged configuration to active](https://docs.ouster.com/sensor-docs/firmware/3.2/api-reference/ouster-http-api/zone-monitor/apply-staged-configuration-to-active.md): Ouster HTTP API > Zone Monitor - [Copy active configuration to staged or revert pending to staged](https://docs.ouster.com/sensor-docs/firmware/3.2/api-reference/ouster-http-api/zone-monitor/copy-active-configuration-to-staged-or-revert-pending-to-staged.md): Ouster HTTP API > Zone Monitor - [Set power-on live zone IDs for staged set](https://docs.ouster.com/sensor-docs/firmware/3.2/api-reference/ouster-http-api/zone-monitor/set-power-on-live-zone-i-ds-for-staged-set.md): Ouster HTTP API > Zone Monitor - [Set sensor-to-body transform configuration for staged set](https://docs.ouster.com/sensor-docs/firmware/3.2/api-reference/ouster-http-api/zone-monitor/set-sensor-to-body-transform-configuration-for-staged-set.md): Ouster HTTP API > Zone Monitor - [Set zone set version information for staged set](https://docs.ouster.com/sensor-docs/firmware/3.2/api-reference/ouster-http-api/zone-monitor/set-zone-set-version-information-for-staged-set.md): Ouster HTTP API > Zone Monitor - [Upload zone configuration from a ZIP file](https://docs.ouster.com/sensor-docs/firmware/3.2/api-reference/ouster-http-api/zone-monitor/upload-zone-configuration-from-a-zip-file.md): Ouster HTTP API > Zone Monitor - [Upload STL file for a zone in staged set](https://docs.ouster.com/sensor-docs/firmware/3.2/api-reference/ouster-http-api/zone-monitor/upload-stl-file-for-a-zone-in-staged-set.md): Ouster HTTP API > Zone Monitor - [Upload ZRB file for a zone in staged set](https://docs.ouster.com/sensor-docs/firmware/3.2/api-reference/ouster-http-api/zone-monitor/upload-zrb-file-for-a-zone-in-staged-set.md): Ouster HTTP API > Zone Monitor - [Set a specific configuration parameter for a zone in staged set](https://docs.ouster.com/sensor-docs/firmware/3.2/api-reference/ouster-http-api/zone-monitor/set-a-specific-configuration-parameter-for-a-zone-in-staged-set.md): Ouster HTTP API > Zone Monitor - [Set STL coordinate frame for a zone in staged set](https://docs.ouster.com/sensor-docs/firmware/3.2/api-reference/ouster-http-api/zone-monitor/set-stl-coordinate-frame-for-a-zone-in-staged-set.md): Ouster HTTP API > Zone Monitor - [Clear staged zone set files](https://docs.ouster.com/sensor-docs/firmware/3.2/api-reference/ouster-http-api/zone-monitor/clear-staged-zone-set-files.md): Ouster HTTP API > Zone Monitor - [Set zone set label](https://docs.ouster.com/sensor-docs/firmware/3.2/api-reference/ouster-http-api/zone-monitor/set-zone-set-label.md): Ouster HTTP API > Zone Monitor - [Clear zone set label](https://docs.ouster.com/sensor-docs/firmware/3.2/api-reference/ouster-http-api/zone-monitor/clear-zone-set-label.md): Ouster HTTP API > Zone Monitor - [Set configuration for a zone](https://docs.ouster.com/sensor-docs/firmware/3.2/api-reference/ouster-http-api/zone-monitor/set-configuration-for-a-zone.md): Ouster HTTP API > Zone Monitor - [Delete configuration for a zone in staged set](https://docs.ouster.com/sensor-docs/firmware/3.2/api-reference/ouster-http-api/zone-monitor/delete-configuration-for-a-zone-in-staged-set.md): Ouster HTTP API > Zone Monitor - [Set zone label](https://docs.ouster.com/sensor-docs/firmware/3.2/api-reference/ouster-http-api/zone-monitor/set-zone-label.md): Ouster HTTP API > Zone Monitor - [Clear zone label](https://docs.ouster.com/sensor-docs/firmware/3.2/api-reference/ouster-http-api/zone-monitor/clear-zone-label.md): Ouster HTTP API > Zone Monitor - [Generate authentication challenge](https://docs.ouster.com/sensor-docs/firmware/3.2/api-reference/ouster-http-api/authentication/get-auth-challenge.md): Ouster HTTP API > Authentication - [Validate JWT and issue session token](https://docs.ouster.com/sensor-docs/firmware/3.2/api-reference/ouster-http-api/authentication/post-auth-login.md): Ouster HTTP API > Authentication - [Logout (invalidate session)](https://docs.ouster.com/sensor-docs/firmware/3.2/api-reference/ouster-http-api/authentication/delete-auth-login.md): Ouster HTTP API > Authentication - [Check authentication status](https://docs.ouster.com/sensor-docs/firmware/3.2/api-reference/ouster-http-api/authentication/get-auth-status.md): Ouster HTTP API > Authentication ## OpenAPI Specification - [OpenAPI JSON](https://docs.ouster.com/sensor-docs/openapi.json): raw OpenAPI 3.1 specification for this API, JSON format - [OpenAPI YAML](https://docs.ouster.com/sensor-docs/openapi.yaml): raw OpenAPI 3.1 specification for this API, YAML format > **Note:** This page contains both a page directory (above) and the landing page content (below). The page directory is generated for agent use and does not appear on the landing page. > For clean Markdown of any page, append .md to the page URL. > For a complete documentation index, see https://docs.ouster.com/sensor-docs/firmware/3.2/api-reference/llms.txt. > For AI client integration (Claude Code, Cursor, etc.), connect to the MCP server at https://docs.ouster.com/sensor-docs/_mcp/server. # API Reference Overview Ouster sensors expose an HTTP API at `/api/v1` served directly from the sensor. Use it to query sensor metadata, configure the sensor, manage firmware, and retrieve diagnostics. The OpenAPI description can be read from `/api/v1/openapi.yaml`. > **Note** > > All configuration parameter names are **case-sensitive**. Refer to the API reference pages for exact spelling. Examples throughout this documentation are tested on Linux. macOS and Windows users should adapt the command syntax accordingly. ## Base URL Requests use the sensor's hostname or IP address as the base: ``` http:///api/v1/ ``` For example, a sensor with hostname `os-992244000006.local`: ```shell curl --request GET http://os-992244000006.local/api/v1/sensor/metadata/sensor_info ``` ## Supported clients The API accepts standard HTTP requests. Any of the following work: | Client | Notes | | ---------------- | --------------------------------------------------------- | | **curl** | Used in all examples throughout this documentation | | **HTTPie** | Human-friendly CLI alternative to curl | | **Browser** | GET endpoints are accessible directly in a web browser | | **REST clients** | Advanced REST Client, Postman, Insomnia, etc. | | **Custom code** | Any HTTP library (Python `requests`, Go `net/http`, etc.) | ## API surface The HTTP API is organized into five resource groups: ### Sensor metadata Read-only endpoints that return fixed sensor properties — serial number, firmware version, calibration data, beam geometry, and data format descriptors. | Endpoint | Description | | ------------------------------------------------ | ---------------------------------------------------------- | | `GET /api/v1/sensor/metadata/sensor_info` | Serial number, firmware revision, product line, and status | | `GET /api/v1/sensor/metadata/lidar_data_format` | Lidar packet structure and channel configuration | | `GET /api/v1/sensor/metadata/imu_data_format` | IMU packet structure | | `GET /api/v1/sensor/metadata/beam_intrinsics` | Per-beam azimuth and altitude angles | | `GET /api/v1/sensor/metadata/lidar_intrinsics` | Lidar-to-sensor coordinate transform | | `GET /api/v1/sensor/metadata/imu_intrinsics` | IMU-to-sensor coordinate transform | | `GET /api/v1/sensor/metadata/calibration_status` | Calibration validity flags | | `GET /api/v1/sensor/metadata` | All metadata fields in a single response | | `GET /api/v1/sensor/mio` | Multipurpose I/O channel state (all channels) | | `GET /api/v1/sensor/mio/{channel}` | Multipurpose I/O channel state (single channel) | ### Sensor configuration Read and modify sensor operating parameters. A `POST` to `/api/v1/sensor/config` applies one or more parameters simultaneously and triggers reinitialization. Individual parameters can also be targeted with `GET`, `PUT`, or `DELETE` on their specific path. | Endpoint | Description | | ------------------------------------------ | ---------------------------------------------- | | `GET /api/v1/sensor/config` | Active configuration | | `POST /api/v1/sensor/config` | Apply one or more configuration parameters | | `GET /api/v1/sensor/config/{param}` | Read a single configuration parameter | | `PUT /api/v1/sensor/config/{param}` | Set a single configuration parameter | | `DELETE /api/v1/sensor/config` | Reset configuration to factory defaults | | `GET /api/v1/sensor/config/operating_mode` | Current operating mode (`NORMAL` or `STANDBY`) | | `PUT /api/v1/sensor/config/operating_mode` | Switch operating mode | ### System Restart the sensor, update firmware, and manage network settings. | Endpoint | Description | | ---------------------------------------------- | --------------------------------------- | | `POST /api/v1/system/restart` | Restart or reinitialize the sensor | | `GET /api/v1/system/firmware` | Installed firmware version | | `POST /api/v1/system/firmware` | Upload and apply a new firmware image | | `GET /api/v1/system/network` | Full network configuration | | `GET /api/v1/system/network/ipv4` | IPv4 address and DHCP status | | `PUT /api/v1/system/network/ipv4/override` | Set a static IPv4 address | | `DELETE /api/v1/system/network/ipv4/override` | Remove the static IP and revert to DHCP | | `PUT /api/v1/system/network/speed_override` | Override link speed | | `DELETE /api/v1/system/network/speed_override` | Remove link speed override | ### Time Query PTP and system time synchronization state. | Endpoint | Description | | ------------------------------ | ------------------------------------ | | `GET /api/v1/time` | Combined sensor and system time info | | `GET /api/v1/time/sensor` | Sensor timestamp and sync mode | | `GET /api/v1/time/system` | Host system clock info | | `GET /api/v1/time/ptp` | PTP synchronization status | | `GET /api/v1/time/ptp/profile` | Active PTP profile | | `PUT /api/v1/time/ptp/profile` | Set PTP profile | ### Alerts and diagnostics Retrieve active and historical alerts, download a full diagnostics bundle, and read live telemetry. | Endpoint | Description | | ---------------------------------------- | --------------------------------------------------------- | | `GET /api/v1/sensor/alerts` | Full alert log | | `GET /api/v1/sensor/alerts?cursor=` | Alert log starting from cursor position | | `GET /api/v1/sensor/alerts?mode=summary` | Active alerts only | | `GET /api/v1/diagnostics/dump` | Complete diagnostics archive (attach to support requests) | | `GET /api/v1/sensor/telemetry` | Live telemetry snapshot | ## Quick example Retrieve sensor info and apply a configuration change in two commands: ```shell # Read sensor info curl http://os-992244000006.local/api/v1/sensor/metadata/sensor_info # Set lidar mode to 1024x10 and point UDP output at a host curl --request POST \ --url http://os-992244000006.local/api/v1/sensor/config \ --header "Content-Type: application/json" \ --data '{"lidar_mode": "1024x10", "udp_dest": "192.0.2.1"}' ``` ## User-editable data Firmware v3.1 added a user-editable data store (`/api/v1/user/data`) for embedding arbitrary metadata on the sensor — calibration notes, site tags, asset IDs, or any other ASCII/Unicode string up to 128 KB. This data persists across reboots and is independent of sensor configuration. ## TCP API (deprecated) The TCP API was deprecated in firmware v3.1. All supported functionality is available through the HTTP API. Contact [Ouster Support](https://ouster.com/tech-support) if you need guidance migrating from the TCP API.