Skip to main content
POST
Add a camera

Authorizations

X-API-Key
string
header
required

A Streamloop API key (sl_…). It carries no workspace: send X-Workspace-Id too (400 WORKSPACE_REQUIRED otherwise).

Headers

Idempotency-Key
string

Retry safely: the key (per caller, workspace, method and path) is taken before the request runs, and its first answer is replayed for 24 hours, with Idempotency-Replayed: true — a repeat sent while the first still runs waits for it. The same key with a different body is 422 IDEMPOTENCY_KEY_REUSED. A 5xx is not kept: the retry runs.

Maximum string length: 200
X-Workspace-Id
string

The workspace to act in. Required with an API key; otherwise the session's own.

Path Parameters

id
string
required

The scene's id (scn_…)

Pattern: ^scn_

Body

application/json
sourceId
string
url
string

rtsp://host[:port]/path, without credentials

username
string
password
string
transport
enum<string>
Available options:
tcp,
udp
camera
string

Test only: a saved camera whose settings fill what is left out

Response

The camera

id
string
sceneId
string
sourceId
string
url
string
username
string
hasPassword
boolean
transport
string
pullId
string
probe
object

The last test's result

hasSnapshot
boolean
updatedAt
string<date-time>