Skip to main content
PUT
Replace recording settings

Authorizations

Authorization
string
header
required

A platform API key, presented as Authorization: Bearer <API_KEY>. Each operation says which permission the key needs.

Path Parameters

space_id
string<uuid>
required

The space to act in.

channel_id
string<uuid>
required

The channel's id.

Body

application/json
engine_version
string
required

The engine version to pin, as major.minor.patch, or empty to follow the current engine. Pinning is not honoured: the value is kept, and the settings follow the current engine.

Maximum string length: 32
settings
object
required

How the channel should record. It follows the recording settings schema of the settings' engine version; a document that does not is stored all the same, and reported as not valid for recording.

Response

The stored settings and whether they are valid for recording.

recording_settings
object
required

How a channel records, or a template of it.

valid
boolean
required

Whether the settings are valid for recording.