minimusdocs
Help center

Watch folders

Scan a watch folder now

POST/vod/watch-folders/{id}/scan/

write Change: creates or edits. Scopes

Starts a scan, or answers the one already queued or running (202).

Path parameters

  • idstring (uuid)required

    The watch folder's id.

Response

202 OK

  • scanobjectrequired
    • 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

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.
  • 404 Nothing with this id, or nothing the account can see.
  • 429 Slow down: wait the seconds in the Retry-After header, then try again.

What each error means