AdminSet recording retention for an RTSP camera (admin; 0 = recording off)

Set recording retention for an RTSP camera (admin; 0 = recording off)

curl -X POST "https://api.spkey.co/admin/rtsp-cameras/example_string/set-recording-retention" \
  -H "Content-Type: application/json" \
  -H "Authorization: Bearer YOUR_API_TOKEN (JWT)" \
  -H "X-API-Key: YOUR_API_KEY" \
  -d '{
  "retentionDays": 42
}'
{
  "success": true,
  "cameraId": "example_string",
  "message": "example_string",
  "event": "null"
}
POST
/admin/rtsp-cameras/{id}/set-recording-retention
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

Content-Typestring
Required

The media type of the request body

Options: application/json
retentionDaysinteger
Required

How many whole days a recorded segment is kept, 0..30; 0 switches recording off

Min: 0 • Max: 30
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

Body

application/json
retentionDaysinteger
Required

How many whole days a recorded segment is kept, 0..30; 0 switches recording off

Responses

successboolean
Required
cameraIdstring
Required
messagestring
eventobject,null