minimusdocs
Help center

Watch folders

Preview a folder before saving it

GET/vod/watch-folders/preview/

read Read: looks, changes nothing. Scopes

What a scan would find in a folder: counts, and up to 8 files and how they are read. It stops at 20,000 files or about 15 seconds. A problem comes back on the field it is about, e.g. {"path": "…"}.

Query parameters

  • extensionsstring
  • folderstring (uuid)
  • kindstring
    • movies - Movies
    • series - TV shows
    • both - Movies and TV shows

    One of: "movies" "series" "both" ""

  • pathstring
  • rootstring
    • incoming - Incoming folder
    • media - Media folder

    One of: "incoming" "media" ""

  • serverstring (uuid)
  • sourcestring
    • node - A server
    • s3 - A bucket

    One of: "node" "s3"

    Default: "node"

  • storagestring (uuid)

Response

200 OK

  • filesintegerrequired
  • moviesintegerrequired
  • episodesintegerrequired
  • showsintegerrequired
  • ignoredintegerrequired

    Files that are not video files.

  • skippedintegerrequired

    Files the folder's kind would leave out.

  • in_panelintegerrequired

    Files whose title the panel has already.

  • watched_byobjectrequiredcan be null

    A watch folder already watching this place.

    • idstring (uuid)required
    • namestringrequired
  • truncatedbooleanrequired
  • notestringrequiredcan be null
  • examplesobject[]required

    Up to 8 files and how they are read.

    • namestringrequired

      The file name.

    • kindstringrequired

      movie or episode.

    • titlestringrequired
    • yearintegerrequiredcan be null
    • showstringrequiredcan be null
    • seasonintegerrequiredcan be null
    • episodeintegerrequiredcan be null

Errors

  • 400 {field: problem}.
  • 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