minimusdocs
Help center

Streams

Preview changing many streams' sources

POST/streams/bulk-edit/sources/preview/

write Change: creates or edits. Scopes

What a change of sources would do to the selection, writing nothing: how many streams change, which find no match and why, a few before and after, and how many restart. Naming a provider is for accounts that see the whole catalogue. A selection is the streams ticked (ids) or every stream the list filters select (all_matching: true with filters, less exclude).

Body

  • selectionobjectrequired

    The streams a bulk action applies to: the ones ticked (ids), or every stream the list filters select (all_matching: true with filters, which take the list's query parameters), less exclude.

    • idsstring (uuid)[]
    • all_matchingboolean

      Default: false

    • filtersobject
    • excludestring (uuid)[]
  • sourcesobjectrequired

    How the sources of the selected streams change. move: each stream gets the same channel on another provider (only when exactly one matches), replacing its old source, as its main source or as its last backup (place). address: part of each address changes (server, or the login in it). remove: the sources on a provider or line are taken out; a stream is never left without one. check: the sources are read again.

    • modestringrequired
      • move - move
      • address - address
      • remove - remove
      • check - check

      One of: "move" "address" "remove" "check"

    • providerinteger
    • placestring

      Default: "replace"

    • replacestring

      Default: "old"

    • followboolean

      Default: false

    • old_providerintegercan be null
    • old_hoststring
    • old_userstring
    • from_hoststring
    • to_basestring
    • from_userstring
    • to_userstring
    • to_passwordstring

Response

200 OK

  • streamsintegerrequired
  • changedintegerrequired
  • sameinteger
  • unmatchedinteger
  • skippedinteger
  • conflictsinteger
  • byobject
  • sources_changedinteger
  • restartsinteger
  • followinteger
  • unmatched_streamsobject[]
  • skipped_streamsobject[]
  • conflict_streamsobject[]
  • sampleobject[]
  • checkobject

    With mode: check only.

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