Remove video qualities or backup

Removes specific qualities (e.g. 720p) and/or the backup (original file) of a video, without deleting the video. It works like the Recycle Bin: the effect is immediate and the files are only permanently deleted after 30 days, so the removal can be undone in the meantime.

How it works

MomentWhat happens
Request (this call)The removed qualities stop being offered by the player, leave available_resolutions and stop counting toward storage. The backup stops being available for download and stops counting toward storage.
Next 30 daysThe items are listed in GET /videos/partial_deletion (and in the Recycle Bin of the dashboard) and can be restored with POST /videos/partial_deletion_cancel.
After 30 days (expires_at)The files are permanently deleted. This cannot be undone: a quality would require reprocessing the video and the backup cannot be recovered.

Rules

  • One video per request, with any number of its items: several qualities and/or the backup in the same call. A JSON array of videos is refused with 400.
  • Items the video does not have are skipped and returned in ignored; the rest is processed. When nothing applies the answer is 200 with action: NOOP.
  • Removing every quality, or the last one left, deletes the whole video: it goes to the trash exactly like DELETE /videos (action: VIDEO_DELETION) and can be recovered with POST /recover. Removing only the backup never deletes the video.
  • Only videos with status CONVERTED are accepted.
  • Each item has its own deadline, counted from the moment it was removed. Editing the video does not change it. Asking again for an item that is already pending keeps the original date.
  • Reprocessing the video is blocked while a removal is pending, since it would bring the removed qualities back. Restore or wait for the deletion first.
  • The pending removal is also returned in the partial_deletion field of GET /videos/{video_id}.
Recent Requests
Log in to see full request history
TimeStatusUser Agent
Retrieving recent requests…
LoadingLoading…
Body Params

What to remove from one video. Send qualities, backup or both.

uuid
required

Id of the video (the id returned by GET /videos).

qualities
array of strings

Qualities to remove, using the labels of available_resolutions of the video (240p, 360p, 480p, 720p, 1080p, 1440p, 2160p). Case and spaces are ignored. Qualities the video does not have are skipped and returned in ignored.qualities.

qualities
boolean
Defaults to false

Remove the backup (the original file sent in the upload). If the video has no backup it is skipped and ignored.backup is true.

Responses

Language
Credentials
Header
LoadingLoading…
Response
Click Try It! to start a request and see the response here! Or choose an example:
application/json