DOdolby
Ingests

Update an ingest by ID

Changed on
patch/ingests/{id}

Request

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

Path parameters

idstring required

Ingest ID

Request body

namestring

Name of the ingest

type'rtmp-push' | 'rtmp-pull' | 'srt-pull' | 'srt-push' | 'sdi-pull' | 'rtsp-pull' | 'ndi-pull'

Ingest type. Note: srt-push requires SRT push to be enabled at organization level

urlstring

Source URL. Must be a valid URL with a host, using the scheme of the ingest type; a port, if present, must be between 0 and 65535 and srt-pull requires an explicit port

regionstring

Region ID. Required for srt-push and rtmp-push. Required for srt-pull and rtmp-pull when single ingest is enabled for the organization, in which case it must be a single ingest enabled region. Required and must be a DUPLO region when a 'speech' enhancement is enabled. Required and must be an on-prem region for rtsp-pull, ndi-pull and sdi-pull (ndi-pull and sdi-pull additionally require the region to support the ingest type)

Response

Updated ingest

Changes

  • baabda2927dbRevision changes
    • info

      added the non-success response with the status

  • 5f4413af6d13Revision changes
    • info

      added the new optional request property //////

    • info

      added the new optional request property //////

    • info

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

    • info

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

    • info

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