minimusdocs
Help center

Video files

List file transfers

GET/vod/jobs/

read Read: looks, changes nothing. Scopes

Every file transfer of movies and episodes (downloads, uploads, copies between servers), newest first, a page at a time. Panel operators only.

Query parameters

  • activeboolean

    Only transfers queued or running.

  • orderingstring

    title_name, method, server_name, state, progress_pct or started_at; - in front for descending.

  • pageinteger

    A page number within the paginated result set.

  • page_sizeinteger

    Number of results to return per page.

  • searchstring

    Matches the title or the file name.

  • serverstring

    A server's instance id.

  • statestring

    One of: "cancelled" "failed" "queued" "running" "succeeded"

Response

200 OK

  • countintegerrequired

    How many there are in all, on every page.

  • nextstring (uri)can be null

    The next page, or null on the last one.

  • previousstring (uri)can be null

    The page before, or null on the first one.

  • resultsobject[]required
    • idstring (uuid)requiredread-only
    • media_filestring (uuid)requiredread-only
    • titleobjectrequiredread-onlycan be null

      The title behind this job, for an operator-legible queue.

      kind is the title's model (movie, episode) and id its key, so the queue can link to the right page. Null while the file exists but no catalogue entry points at it. Reached through the media file's reverse one-to-one; the list view selects those relations so this costs no query per row.

    • serverstring (uuid)requiredread-only
    • server_namestringrequiredread-only
    • methodstringrequiredread-only
    • source_refanyrequiredread-only

      Method-specific locator: the URL to pull, the watch-folder path, the bucket and key of an object, the peer node for a replication. An object is recorded by its key and signed only when the job is sent to the node — a queued job can wait longer than any signed URL lives — and the node receives an ordinary HTTPS URL, so it needs no cloud SDK and object storage is just a URL pull.

    • statestringrequiredread-only
    • phasestringrequiredread-only

      What the node is doing right now: waiting for a free slot, downloading, uploading, probing, publishing.

    • progress_pctintegerrequiredread-only
    • bytes_doneintegerrequiredread-only
    • bytes_totalintegerrequiredread-only
    • errorstringrequiredread-only
    • attemptsintegerrequiredread-only
    • created_atstring (date-time)requiredread-only
    • started_atstring (date-time)requiredread-onlycan be null
    • finished_atstring (date-time)requiredread-onlycan be null

Errors

  • 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