Application Recording Settings Update

Updates the recording settings for an application.

Request

Property	Value
Method	`PATCH`
URL	`/api/applications/{appName}/settings/recording`
Content-Type	`application/json`
Authentication	Bearer Token

Request

bash

curl -X PATCH "{BASE_URL}/api/applications/{appName}/settings/recording" \
  -H "Authorization: Bearer YOUR_TOKEN" \
  -H "Content-Type: application/json" \
  -d '{"key": "value"}'

Path Parameters

Parameter	Type	Required	Description
`appName`	string	Yes	Application name

Request

bash

curl -X PATCH "{BASE_URL}/api/applications/{appName}/settings/recording" \
  -H "Authorization: Bearer YOUR_TOKEN" \
  -H "Content-Type: application/json"

Request Body

Parameter	Type	Required	Description
`data.attributes.enabled`	boolean	No	Enable recording
`data.attributes.fileFormat`	"fMP4" \| "FLV"	No	Recording file format
`data.attributes.savePath`	string	No	Directory path for recordings
`data.attributes.maxFileSize`	integer	No	Maximum file size in MB
`data.attributes.maxFileDuration`	integer	No	Maximum file duration in seconds
`data.attributes.cacheSize`	integer	No	Cache size in seconds
`data.attributes.maxStorageSize`	integer	No	Maximum total storage size in MB
`data.attributes.removeOldFiles`	boolean	No	Automatically remove old files when storage is full
`data.attributes.autoRecording`	boolean	No	Automatically start recording when stream starts

Example Request (Enable Recording)

Example Request (Disable Recording)

json

{
  "data": {
    "attributes": {
      "enabled": true,
      "fileFormat": "fMP4",
      "savePath": "/var/recordings",
      "maxFileSize": 100,
      "maxFileDuration": 3600,
      "cacheSize": 5,
      "maxStorageSize": 10000,
      "removeOldFiles": true,
      "autoRecording": false
    }
  }
}

json

{
  "data": {
    "attributes": {
      "enabled": false
    }
  }
}

Response Body

Recording Settings

Parameter	Type	Description
`data.attributes.enabled.value`	boolean	Recording enabled status
`data.attributes.enabled.editable`	boolean	Indicates if the field can be modified
`data.attributes.enabled.lockedBy`	string	Locked by environment variable (if present)
`data.attributes.fileFormat.value`	"fMP4" \| "FLV"	Recording file format
`data.attributes.fileFormat.editable`	boolean	Indicates if the field can be modified
`data.attributes.fileFormat.lockedBy`	string	Locked by environment variable (if present)
`data.attributes.savePath.value`	string	Directory path for recordings
`data.attributes.savePath.editable`	boolean	Indicates if the field can be modified
`data.attributes.savePath.lockedBy`	string	Locked by environment variable (if present)
`data.attributes.maxFileSize.value`	integer	Maximum file size in MB
`data.attributes.maxFileSize.editable`	boolean	Indicates if the field can be modified
`data.attributes.maxFileSize.lockedBy`	string	Locked by environment variable (if present)
`data.attributes.maxFileDuration.value`	integer	Maximum file duration in seconds
`data.attributes.maxFileDuration.editable`	boolean	Indicates if the field can be modified
`data.attributes.maxFileDuration.lockedBy`	string	Locked by environment variable (if present)
`data.attributes.cacheSize.value`	integer	Cache size in seconds
`data.attributes.cacheSize.editable`	boolean	Indicates if the field can be modified
`data.attributes.cacheSize.lockedBy`	string	Locked by environment variable (if present)
`data.attributes.maxStorageSize.value`	integer	Maximum total storage size in MB
`data.attributes.maxStorageSize.editable`	boolean	Indicates if the field can be modified
`data.attributes.maxStorageSize.lockedBy`	string	Locked by environment variable (if present)
`data.attributes.removeOldFiles.value`	boolean	Auto-remove old files when storage is full
`data.attributes.removeOldFiles.editable`	boolean	Indicates if the field can be modified
`data.attributes.removeOldFiles.lockedBy`	string	Locked by environment variable (if present)
`data.attributes.autoRecording.value`	boolean	Auto-start recording when stream starts
`data.attributes.autoRecording.editable`	boolean	Indicates if the field can be modified
`data.attributes.autoRecording.lockedBy`	string	Locked by environment variable (if present)
`message`	string	Response status message

Metadata

Parameter	Type	Description
`meta.executionTime`	integer	Request processing time in milliseconds
`meta.generatedAt`	integer	Response generation timestamp (Unix timestamp in ms)

Successful Response (200)

json

{
  "data": {
    "attributes": {
      "enabled": {
        "editable": true,
        "value": true
      },
      "fileFormat": {
        "editable": true,
        "value": "fMP4"
      },
      "savePath": {
        "editable": true,
        "value": "/var/recordings"
      },
      "maxFileSize": {
        "editable": true,
        "value": 100
      },
      "maxFileDuration": {
        "editable": true,
        "value": 3600
      },
      "cacheSize": {
        "editable": true,
        "value": 5
      },
      "maxStorageSize": {
        "editable": true,
        "value": 10000
      },
      "removeOldFiles": {
        "editable": true,
        "value": true
      },
      "autoRecording": {
        "editable": true,
        "value": false
      }
    }
  },
  "meta": {
    "executionTime": 14,
    "generatedAt": 1766070737249
  },
  "message": "Recording Settings have been updated"
}

Error Responses

Application Not Found (404)

Parameter	Type	Description
`message`	string	Human-readable error message

json

{
  "message": "Application not found"
}

Support Needed?

Create a free ticket and our support team will provide you necessary assistance.