Skip to main content
PUT
Stop the recording

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.

Response

The stop was requested.

One attempt of a recording job.

aborted
boolean
required

Whether the recording was asked to stop immediately rather than run on to its end point.

attempt_number
integer
required

Zero-based position of this attempt within its request.

id
string<uuid>
required
request_id
string<uuid>
required

Groups every attempt of one recording job.

status
enum<string>
required

scheduled is requested but not started; recording is in progress; complete finished as requested; failed hit an error; aborted was cut short, so its outputs may be incomplete.

Available options:
scheduled,
recording,
complete,
failed,
aborted
ended_at
string<date-time>
outputs
object[]
requested_start_at
string<date-time>

With requested_stop_at, the window the recording was asked to cover.

requested_stop_at
string<date-time>
started_at
string<date-time>