RtspCameraRegister a new RTSP camera

Register a new RTSP camera

Creates a new RtspCameraAggregate. With video control enabled, encrypted source staging happens first and the response reports placementStatus=pending; the rollout flag can temporarily restore the legacy direct-VMS path.

curl -X POST "https://api.spkey.co/rtsp-cameras/example_string/RegisterRtspCamera" \
  -H "Content-Type: application/json" \
  -H "Authorization: Bearer YOUR_API_TOKEN (JWT)" \
  -H "X-API-Key: YOUR_API_KEY" \
  -d '{
  "cameraId": "example_string",
  "name": "John Doe",
  "rtspUrl": "example_string",
  "username": "John Doe",
  "password": "example_string",
  "httpSnapshotUrl": "example_string",
  "ownerId": "example_string",
  "orgId": "example_string"
}'
{
  "success": true,
  "aggregateId": "example_string",
  "version": 3.14,
  "placementStatus": "pending",
  "event": "null"
}
POST
/rtsp-cameras/{id}/RegisterRtspCamera
POST
Base URLstring

Target server for requests. Edit to use your own host.

Bearer Token (JWT)
Bearer Tokenstring
Required

JWT token from SmartphoneKey authentication. Identifies the B2C user or B2B service.

JWT token from SmartphoneKey authentication. Identifies the B2C user or B2B service.
API Key (header: X-API-Key)
X-API-Keystring
Required

API key for B2B organization access. Provided during organization onboarding.

API key for B2B organization access. Provided during organization onboarding.
path
idstring
Required

RTSP camera UUID (aggregate id)

Content-Typestring
Required

The media type of the request body

Options: application/json
cameraIdstring
Required

Camera UUID (caller-supplied or server-generated)

namestring
Required

Human-readable camera name

Min length: 1
rtspUrlstring
Required

RTSP source URL (e.g. rtsp://1.2.3.4:554/stream)

Min length: 1
usernamestring

RTSP authentication username

passwordstring

RTSP authentication password

httpSnapshotUrlstring

Optional HTTP JPEG/PNG snapshot endpoint

ownerIdstring

B2C user ID who owns this camera

orgIdstring

B2B organisation that owns this camera

Request Preview
Response

Response will appear here after sending the request

Authentication

header
Authorizationstring
Required

Bearer token (JWT). JWT token from SmartphoneKey authentication. Identifies the B2C user or B2B service.

header
X-API-Keystring
Required

API Key for authentication. API key for B2B organization access. Provided during organization onboarding.

Path Parameters

idstring
Required

RTSP camera UUID (aggregate id)

Body

application/json
cameraIdstring
Required

Camera UUID (caller-supplied or server-generated)

namestring
Required

Human-readable camera name

rtspUrlstring
Required

RTSP source URL (e.g. rtsp://1.2.3.4:554/stream)

usernamestring

RTSP authentication username

passwordstring

RTSP authentication password

httpSnapshotUrlstring

Optional HTTP JPEG/PNG snapshot endpoint

ownerIdstring

B2C user ID who owns this camera

orgIdstring

B2B organisation that owns this camera

Responses

successboolean
Required
aggregateIdstring
Required
versionnumber
Required
placementStatusstring
Required
Allowed values:pendingrunning
eventobject,null
Required