minimusdocs
Help center

Watch folders

Create a watch folder

POST/vod/watch-folders/

write Change: creates or edits. Scopes

Saves a folder whose new files are added on their own; a folder that is on starts its first scan at once. The folder must exist and must not overlap another watch folder. Panel operators only.

Body

  • namestring

    Empty: the folder's own name.

  • is_enabledboolean

    Off: paused, the folder is scanned only when asked.

  • kindstring

    What the folder holds. A file that looks like the other kind is skipped, and says so.

    • movies - Movies
    • series - TV shows
    • both - Movies and TV shows
  • sourcestring
    • node - A server
    • s3 - A bucket

    One of: "node" "s3"

  • serverstring (uuid)can be null
  • rootstring

    Incoming folder: files are moved into the server's storage. Media folder: files stay where they are.

    • incoming - Incoming folder
    • media - Media folder
  • pathstring
  • storagestring (uuid)can be null
  • deliverystring
    • adopt - Moved into the server's storage
    • link - Served where it is
    • download - Downloaded to a server
    • proxy - Played through a server
    • redirect - Played straight from the bucket

    One of: "adopt" "link" "download" "proxy" "redirect"

  • scan_every_minutesinteger
  • categoriesstring

    Folder names: "Action/Heat (1995).mkv" goes under Action (a file in no such folder goes under its TMDB genres). TMDB genres. One category for movies and one for TV shows. Or your own mapping of folder names (else genres) to categories.

    • folder - Folder names
    • tmdb - TMDB genres
    • fixed - One category
    • custom - My own mapping
  • movie_categorystring (uuid)can be null
  • series_categorystring (uuid)can be null
  • category_mapany
  • movie_bouquetsstring (uuid)[]
  • series_bouquetsstring (uuid)[]
  • use_tmdbboolean

    Fill posters, plots, cast and ratings from TMDB (the key in Settings → VOD).

  • add_unmatchedboolean

    A title TMDB does not know is added with its file name. Off: it waits for you.

  • tmdb_languagestring

    Language of titles and plots from TMDB, e.g. fr-FR. Empty: the one in Settings → VOD.

  • extensionsstring

    Only files with these extensions are read, e.g. mkv,mp4.

Response

201 OK

  • idstring (uuid)requiredread-only
  • namestring

    Empty: the folder's own name.

  • display_namestringrequiredread-only
  • is_enabledboolean

    Off: paused, the folder is scanned only when asked.

  • kindstring

    What the folder holds. A file that looks like the other kind is skipped, and says so.

    • movies - Movies
    • series - TV shows
    • both - Movies and TV shows
  • sourcestring
    • node - A server
    • s3 - A bucket

    One of: "node" "s3"

  • serverstring (uuid)can be null
  • server_namestringrequiredread-only
  • rootstring

    Incoming folder: files are moved into the server's storage. Media folder: files stay where they are.

    • incoming - Incoming folder
    • media - Media folder
  • pathstring
  • storagestring (uuid)can be null
  • storage_namestringrequiredread-only
  • deliverystring
    • adopt - Moved into the server's storage
    • link - Served where it is
    • download - Downloaded to a server
    • proxy - Played through a server
    • redirect - Played straight from the bucket

    One of: "adopt" "link" "download" "proxy" "redirect"

  • scan_every_minutesinteger
  • categoriesstring

    Folder names: "Action/Heat (1995).mkv" goes under Action (a file in no such folder goes under its TMDB genres). TMDB genres. One category for movies and one for TV shows. Or your own mapping of folder names (else genres) to categories.

    • folder - Folder names
    • tmdb - TMDB genres
    • fixed - One category
    • custom - My own mapping
  • movie_categorystring (uuid)can be null
  • series_categorystring (uuid)can be null
  • category_mapany
  • movie_bouquetsstring (uuid)[]
  • series_bouquetsstring (uuid)[]
  • use_tmdbboolean

    Fill posters, plots, cast and ratings from TMDB (the key in Settings → VOD).

  • add_unmatchedboolean

    A title TMDB does not know is added with its file name. Off: it waits for you.

  • tmdb_languagestring

    Language of titles and plots from TMDB, e.g. fr-FR. Empty: the one in Settings → VOD.

  • extensionsstring

    Only files with these extensions are read, e.g. mkv,mp4.

  • next_scan_atstring (date-time)requiredread-onlycan be null
  • last_scan_atstring (date-time)requiredread-onlycan be null
  • created_bystring (uuid)requiredread-onlycan be null
  • created_atstring (date-time)requiredread-only
  • updated_atstring (date-time)requiredread-only
  • countsobjectrequiredread-only
  • last_scanobjectrequiredread-onlycan be null
    • idstring (uuid)requiredread-only
    • triggerstringrequiredread-only
    • statusstringrequiredread-only
    • phasestringrequiredread-only
    • doneintegerrequiredread-only
    • totalintegerrequiredread-only
    • countsanyrequiredread-only
    • messagestringrequiredread-only
    • created_atstring (date-time)requiredread-only
    • started_atstring (date-time)requiredread-onlycan be null
    • finished_atstring (date-time)requiredread-onlycan be null
  • scanningbooleanrequiredread-only
  • problemstringrequiredread-onlycan be null

    Why the last scan that ended failed, in a sentence; None when it did not (kept while the folder is paused).

Errors

  • 400 Something sent is not valid. Each field that is wrong is named with what is wrong.
  • 401 No credential, or one that is wrong, expired or revoked.
  • 403 The account, or the key's or app's scopes, may not do this.
  • 429 Slow down: wait the seconds in the Retry-After header, then try again.

What each error means