RtspCameraGet RTSP camera state

Get RTSP camera state

curl -X GET "https://api.spkey.co/rtsp-cameras/example_string" \
  -H "Content-Type: application/json" \
  -H "Authorization: Bearer YOUR_API_TOKEN (JWT)" \
  -H "X-API-Key: YOUR_API_KEY"
{
  "cameraId": "example_string",
  "name": "John Doe",
  "status": "working",
  "placementStatus": "pending",
  "placementError": "example_string",
  "streamId": "example_string",
  "hlsPath": "example_string",
  "signedHlsUrl": "example_string",
  "hlsExpiresAt": 3.14,
  "httpSnapshotUrl": "example_string",
  "signedPreviewUrl": "example_string",
  "previewExpiresAt": 3.14,
  "ownerId": "example_string",
  "orgId": "example_string",
  "accessGrants": [
    {
      "userId": "example_string",
      "role": "viewer",
      "grantedAt": "example_string"
    }
  ],
  "createdAt": "example_string",
  "updatedAt": "example_string"
}
GET
/rtsp-cameras/{id}
GET
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)

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)

Responses

cameraIdstring
Required
namestring
Required
statusstring
Required
Allowed values:workingstoppeddeleted
placementStatusstring
Required
Allowed values:pendingrunningfailedreleased
placementErrorstring
streamIdstring
Required
hlsPathstring
Required
signedHlsUrlstring
hlsExpiresAtnumber
httpSnapshotUrlstring
signedPreviewUrlstring
previewExpiresAtnumber
ownerIdstring
orgIdstring
accessGrantsarray
Required
createdAtstring
Required
updatedAtstring
Required