# Device Streams

## List Streams

List every stream configured on a device.

**Required scope:** `device:read`

{% openapi src="/files/qJPD2mHy2OK1cmpxNjKJ" path="/{workspace}/devices/v2/{deviceId}/streams" method="get" %}
[deployment-manager.yaml](https://1284666567-files.gitbook.io/~/files/v0/b/gitbook-x-prod.appspot.com/o/spaces%2Fe5GEiPeDoFksvZv1vH3A%2Fuploads%2Fgit-blob-d9842382ea00557904abc587230b904ebf240466%2Fdeployment-manager.yaml?alt=media)
{% endopenapi %}

### Example Request

```bash
curl "https://api.roboflow.com/{workspace}/devices/v2/{deviceId}/streams?api_key=$ROBOFLOW_API_KEY"
```

### Example Response

```json
{
  "data": [
    {
      "id": "stream_abc",
      "name": "entrance-cam",
      "status": "running",
      "pipeline_id": "pipe_123",
      "workflow_id": "wf_456",
      "source": "rtsp://192.168.1.100:554/live",
      "started_at": "2026-04-28T10:00:00.000Z",
      "last_event_at": "2026-04-28T12:30:00.000Z",
      "camera_fps": 29.97,
      "inference_fps": 12.4,
      "sharpness": 0.82,
      "error": null
    }
  ]
}
```

### Source sanitization

The `source` field is always passed through a sanitizer before it is returned:

* If the source is a URL, any `userinfo` (`scheme://user:pass@host/...`) is stripped. For example, `rtsp://admin:password@192.168.1.100:554/live` becomes `rtsp://192.168.1.100:554/live`.
* If the source is an object, keys whose lowercase name is `password`, `passwd`, `secret`, `api_key`, `apikey`, `auth`, `authorization`, `token`, or `access_token` are dropped from the response. All other keys are preserved.
* Arrays and nested objects are sanitized recursively.

## Get Stream

Retrieve a single stream. Returns **404** if the stream does not exist on the device, or if the device does not exist or does not belong to your workspace.

**Required scope:** `device:read`

{% openapi src="/files/qJPD2mHy2OK1cmpxNjKJ" path="/{workspace}/devices/v2/{deviceId}/streams/{streamId}" method="get" %}
[deployment-manager.yaml](https://1284666567-files.gitbook.io/~/files/v0/b/gitbook-x-prod.appspot.com/o/spaces%2Fe5GEiPeDoFksvZv1vH3A%2Fuploads%2Fgit-blob-d9842382ea00557904abc587230b904ebf240466%2Fdeployment-manager.yaml?alt=media)
{% endopenapi %}

### Example Request

```bash
curl "https://api.roboflow.com/{workspace}/devices/v2/{deviceId}/streams/{streamId}?api_key=$ROBOFLOW_API_KEY"
```

The response body matches a single item from the list endpoint (not wrapped in a `data` array).


---

# Agent Instructions: Querying This Documentation

If you need additional information that is not directly available in this page, you can query the documentation dynamically by asking a question.

Perform an HTTP GET request on the current page URL with the `ask` query parameter:

```
GET https://docs.roboflow.com/developer/rest-api/deployment-manager/device-streams.md?ask=<question>
```

The question should be specific, self-contained, and written in natural language.
The response will contain a direct answer to the question and relevant excerpts and sources from the documentation.

Use this mechanism when the answer is not explicitly present in the current page, you need clarification or additional context, or you want to retrieve related documentation sections.