Tools/Recordings

Start a device recording

post/devices/{deviceId}/recordings

Path parameters

deviceIdstring required

Request body

$schemastring uri

A URL to the JSON Schema for this object.

namestring
retentionDaysinteger
typesstring[] nullable

Example request

{
  "$schema": "https://example.com/schemas/StartInputBody.json"
}

Response

Created

$schemastring uri

A URL to the JSON Schema for this object.

actionsinteger required
deviceIdstring required
endedAtstring date-time
errorstring
expiresAtstring date-time required
idstring required
namestring required
startedAtstring date-time required
statusstring required
typesstring[] nullable required

Example response

{
  "$schema": "https://example.com/schemas/RecordingInfo.json"
}

Changes