DOdolby
Distributions

Update a distribution by ID

Changed on
patch/distributions/{id}

Request

  • Base URL
    https://api.theo.live/v2
  • Auth
    HTTP basic

Path parameters

idstring required

Distribution ID

Request body

namestring

Name of the distribution

externalIdstring nullable

Deprecated, use 'externalIds' instead. Shorthand for a single-entry 'externalIds'. For now, responses will keep returning 'externalId' with the first entry of 'externalIds'. Set to null to clear all external IDs.

externalIdsstring[]

External identifiers for the distribution. Replaces the full list; an empty array clears all external IDs. Mutually exclusive with externalId.

enabledboolean

Whether the distribution is enabled

targetLatencynumber

Target latency in seconds for playback (0.5-30). Also applied as latencies.hesp.

maxBitratenumber nullable

Maximum bitrate limit in bps

Response

Updated distribution

Changes

  • 580fe8e1db6bRevision changes
    • warning

      added the new chromecast enum value to the /////// response property for the response status

    • info

      added the new chromecast enum value to the request property //

  • 38d9631a5c4aRevision changes
    • info

      added the new optional request property

    • info

      request property deprecated

    • info

      added the optional property ///// to the response with the status

    • info

      response property data/allOf[Distribution]/externalId deprecated