Manage Videos

Cleanup unconfigured resolutions

Changed on

Deletes stored resolution files that are no longer configured for the library, or the specific resolutions passed in resolutionsToDelete/allResolutions. This cannot be undone. If the library has 'keep original files' turned off, the original source file is also deleted as part of this cleanup even when deleteOriginal is not set.

post/library/{libraryId}/videos/{videoId}/resolutions/cleanup

Request

Path parameters

libraryIdinteger required

The ID of the video library.

videoIdstring required

The GUID of the video.

Query parameters

resolutionsToDeletestring nullable

Comma-separated list of specific resolutions to delete (e.g. "720p,480p"), instead of relying on deleteNonConfiguredResolutions/allResolutions.

deleteNonConfiguredResolutionsboolean

If set to true, all resolutions not currently configured for the library will be deleted.

allResolutionsboolean

If set to true, all resolutions for the video will be deleted, regardless of library configuration. When targeting HLS resolutions (the default, or outputs=all), at least one resolution must remain after cleanup or the request is rejected — scope outputs to mp4 to remove every rendition.

deleteOriginalboolean

If set to true, the original source file is deleted as well. Note: the original is also deleted when the library has 'keep original files' disabled, regardless of this flag.

outputsstring nullable

Outputs to clean. Supported values: hls, mp4, all

deleteMp4Filesboolean

If set to true, MP4 fallback files for the deleted resolutions are removed too.

dryRunboolean

If set to true, no actual file manipulation will happen, only informational data will be returned

Response

The resolutions were successfully deleted

successboolean

Determines if the request was successful

messagestring nullable

Human-readable message describing the result, typically populated with error details when Success is false.

statusCodeinteger

The HTTP status code corresponding to the result of the request.

Changes

    • breaking

      the response's body type changed from object to no type for status

    • warning

      removed the optional property from the response with the status

    • warning

      removed the optional property from the response with the status

    • warning

      removed the optional property from the response with the status

    • info

      added subschema #2 to the response body allOf list for the response status

    • info

      added the media type application/json for the response with the status

    • info

      added the media type application/json for the response with the status

    • info

      added the non-success response with the status