Monitoring

Start monitoring

Turns monitoring on. For a live monitor, a channel that is already live starts being recorded within about a minute, and clips come from what airs from then on; nothing before the start is clipped. Calling it on a monitor that is already on changes nothing and answers 200. Refusals: 402, 403, 404.

post/monitors/{id}/start

Request

  • Base URL: https://api.cut.pro/api/v1
  • URL: https://api.cut.pro/api/v1/monitors/{id}/start
  • Auth: API key in header X-Api-Key

Path parameters

idstring required

Response

Response for status 200

idstring required
type'live' | 'video' required
platform'youtube' | 'twitch' | 'kick' required
usernamestring required
display_namestring nullable required
avatar_urlstring nullable required
enabledboolean required
enabled_atstring nullable required

ISO 8601 timestamp of when the current monitoring period started; null while off. Stopping is refused for the first 10 minutes after it.

strategy_idstring required

Clipping strategy applied to every clip

template_idstring nullable required

Edit template applied to every clip; null = none

video_min_durationnumber nullable required

video only: shorter uploads are skipped, in seconds

video_max_durationnumber nullable required

video only: longer uploads are skipped, in seconds

days_of_weeknumber[] required

video only: days an upload is accepted, 0 = Sunday; empty = every day

Changes

No recorded changes to this operation across all 1 revision of this API.