Providers

Replace a provider

PUT/streams/providers/{id}/

write Change: creates or edits. Scopes

Saves every field of a provider. An empty password keeps the saved one. A new login or link format syncs it again, and the streams that follow it get the new links. Panel operators only.

Path parameters

  • idintegerrequired

    The provider id.

Body

  • namestringrequired
  • kindstring
    • xtream - A provider login: server, username and password
    • m3u - An M3U address

    One of: "xtream" "m3u"

  • usernamestring
  • is_enabledboolean

    Off: the provider is neither checked nor synced.

  • sync_every_minutesinteger
  • use_liveboolean

    Its live channels are offered for streams to follow. Off: a provider for its films or TV shows only.

  • import_moviesboolean

    After each sync, the provider's new films are added to Films.

  • import_seriesboolean

    After each sync, the provider's new shows and episodes are added to TV shows.

  • urlstringrequired
  • passwordstring
  • extra_hostsstring[]
  • link_formatstring
    • ts - MPEG-TS (.ts)
    • m3u8 - HLS (.m3u8)

    One of: "ts" "m3u8"

  • sync_namesboolean

    Streams that follow a channel take its name whenever the provider's differs.

  • sync_logosboolean

    Streams that follow a channel take its logo.

  • sync_epg_idsboolean

    Streams that follow a channel take its guide id, when the panel's guide has it.

  • keep_historyboolean

    Keep a list of past syncs (the last 50). Off saves space: only the last result is kept.

  • vod_categoriesstring

    Where imported titles are filed: under the provider's own categories, under their TMDB genres, or as your mapping says.

    • playlist - The provider's categories
    • tmdb - TMDB genres
    • custom - My own mapping
  • vod_category_mapany
  • vod_bouquetsstring (uuid)[]
  • vod_series_bouquetsstring (uuid)[]
  • vod_deliverystring

    Straight from the provider: the player is sent to the provider, which costs you no bandwidth but shows the player its address. Through a streaming server: a server passes the film through, hiding the provider, and every byte crosses it — always the one you choose, or any healthy one the panel picks (load balanced).

    • redirect - Straight from the provider
    • proxy - Through one streaming server
    • balanced - Through any streaming server (load balanced)
  • vod_proxy_serverstring (uuid)can be null
  • vod_tmdbboolean

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

  • spareintegercan be null

Response

200 OK

  • idintegerrequiredread-only
  • namestringrequired
  • kindstring
    • xtream - A provider login: server, username and password
    • m3u - An M3U address

    One of: "xtream" "m3u"

  • addressstringrequiredread-only
  • usernamestring
  • is_enabledboolean

    Off: the provider is neither checked nor synced.

  • statusstringrequiredread-only
  • status_detailstringrequiredread-only
  • checked_atstring (date-time)requiredread-onlycan be null
  • connectionsobjectrequiredread-only
    • activeintegerrequiredcan be null

      Connections in use, as the provider said.

    • maxintegerrequiredcan be null

      Connections the line allows.

    • oursintegerrequired

      Connections this panel's servers hold on it now.

  • expires_atstring (date-time)requiredread-onlycan be null
  • expires_knownbooleanrequiredread-only

    Whether expires_at is what the provider said (null: never expires) rather than nothing known: it refused the login, could not be reached, or is an M3U, which says nothing about an expiry.

  • is_trialbooleanrequiredread-only
  • account_created_atstring (date-time)requiredread-onlycan be null
  • countsobjectrequiredread-only
    • liveintegerrequired

      Channels.

    • moviesintegerrequired
    • seriesintegerrequired

      TV shows.

  • sync_every_minutesinteger
  • last_sync_started_atstring (date-time)requiredread-onlycan be null
  • last_sync_atstring (date-time)requiredread-onlycan be null
  • last_sync_okbooleanrequiredread-onlycan be null
  • last_sync_summaryanyrequiredread-only
  • next_sync_atstring (date-time)requiredread-onlycan be null
  • syncingbooleanrequiredread-only
  • linked_streamsintegerrequiredread-only

    Default: 0

  • gone_linksintegerrequiredread-only

    Default: 0

  • use_liveboolean

    Its live channels are offered for streams to follow. Off: a provider for its films or TV shows only.

  • import_moviesboolean

    After each sync, the provider's new films are added to Films.

  • import_seriesboolean

    After each sync, the provider's new shows and episodes are added to TV shows.

  • urlstringrequired
  • has_passwordbooleanrequiredread-only
  • extra_hostsstring[]
  • link_formatstring
    • ts - MPEG-TS (.ts)
    • m3u8 - HLS (.m3u8)

    One of: "ts" "m3u8"

  • sync_namesboolean

    Streams that follow a channel take its name whenever the provider's differs.

  • sync_logosboolean

    Streams that follow a channel take its logo.

  • sync_epg_idsboolean

    Streams that follow a channel take its guide id, when the panel's guide has it.

  • keep_historyboolean

    Keep a list of past syncs (the last 50). Off saves space: only the last result is kept.

  • vod_categoriesstring

    Where imported titles are filed: under the provider's own categories, under their TMDB genres, or as your mapping says.

    • playlist - The provider's categories
    • tmdb - TMDB genres
    • custom - My own mapping
  • vod_category_mapany
  • vod_bouquetsstring (uuid)[]
  • vod_series_bouquetsstring (uuid)[]
  • vod_deliverystring

    Straight from the provider: the player is sent to the provider, which costs you no bandwidth but shows the player its address. Through a streaming server: a server passes the film through, hiding the provider, and every byte crosses it — always the one you choose, or any healthy one the panel picks (load balanced).

    • redirect - Straight from the provider
    • proxy - Through one streaming server
    • balanced - Through any streaming server (load balanced)
  • vod_proxy_serverstring (uuid)can be null
  • vod_tmdbboolean

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

  • vodobjectrequiredread-only
    • waitingintegerrequired

      Movies and episodes waiting to be imported.

    • importedintegerrequired
    • skippedintegerrequired
    • failedintegerrequired
    • lastobjectrequiredcan be null

      The last import, if any.

      • idstring (uuid)required
      • statusstringrequired

        pending, running, completed, failed or cancelled.

      • phasestringrequired
      • doneintegerrequired
      • totalintegerrequired
      • countsobjectrequired
      • messagestringrequired
      • created_atstring (date-time)required
      • started_atstring (date-time)requiredcan be null
      • finished_atstring (date-time)requiredcan be null
      • updated_atstring (date-time)required
  • spareintegercan be null
  • spare_namestringrequiredread-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.
  • 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