channel import.md

Channel Import

Channels API · import-export

POST /ui/connectors/channels-api/latest/import/

Import channels from a JSON payload.

mode=merge (default): create missing, update changed, leave others alone. mode=replace: delete any channel not in the payload, then create/update. An empty channels list with mode=replace deletes all channels.

Returns immediately. Background tasks push service configs to the controller; observe final per-channel state via GET /channels/{id}/ (sync_state).

Request body

Content type: application/json · Required

payload · object · Required
- schemaVersion · string · Optional · Defaults to 1
- description · object · Optional
  - One of the following variants:
    - string (string)
    - null (null)
- exportedAt · string · Required · format: date-time
- sourceVersion · object · Optional
  - One of the following variants:
    - string (string)
    - null (null)
- channels · list of objects · Required
  - Array items (object):
    - kind · string · Optional · Defaults to BeamChannel
    - metadata · object · Required
      - name · string · Required
      - displayName · string · Required
    - spec · object · Required
      - type · enum · Required
        
        Allowed values: EncodingContribution, EncodingDistribution, ReceptionDecoding, ReceptionGateway, EncodingStreaming
      - state · enum · Optional · Defaults to Stopped
        
        Allowed values: Running, Stopped
      - inputs · list of objects · Optional · Defaults to []
        
        Array items (object):
        
        One of the following variants, selected by type:
        
        SRTCaller (object)
        
        type · string · Optional · Defaults to SRTCaller
        
        name · string · Required
        
        transport · object · Required
        
        url · string · Required · pattern: ^srt://
        
        interface · object · Optional
        
        One of the following variants:
        
        string (string)
        
        null (null)
        
        latency · double · Optional · 0.06 to 8 · Defaults to 0.125
        
        encryptionStandard · enum · Optional · Defaults to None
        
        Allowed values: Unsynced, None, AES128, AES192, AES256
        
        passPhrase · object · Optional
        
        One of the following variants:
        
        string (string)
        
        null (null)
        
        payload · object · Optional
        
        One of the following variants:
        
        MptsPayload (object)
        
        programNumber · string · Optional · Defaults to 1
        
        delayMode · enum · Optional · Defaults to Standard
        
        Allowed values: Unsynced, Standard, Low, SuperLow
        
        decrypt · object · Optional
        
        One of the following variants:
        
        DecryptConfig (object)
        
        type · enum · Optional · Defaults to None
        
        Allowed values: Unsynced, None, BISS, BISSCA, DVBCI
        
        bissMode · object · Optional
        
        One of the following variants:
        
        BissMode (enum)
        
        null (null)
        
        bissKey · object · Optional
        
        One of the following variants:
        
        string (string)
        
        null (null)
        
        bissInjectedKeyId · object · Optional
        
        One of the following variants:
        
        string (string)
        
        null (null)
        
        bissCAKeyId · object · Optional
        
        One of the following variants:
        
        string (string)
        
        null (null)
        
        camSlot · object · Optional
        
        One of the following variants:
        
        integer (integer)
        
        null (null)
        
        camPort · object · Optional
        
        One of the following variants:
        
        integer (integer)
        
        null (null)
        
        null (null)
        
        null (null)
        
        SRTListener (object)
        
        type · string · Optional · Defaults to SRTListener
        
        name · string · Required
        
        transport · object · Required
        
        interface · string · Required
        
        port · integer · Required · 256 to 65535 — Port number
        
        maxConnections · integer · Optional · >=1 · Defaults to 10
        
        latency · double · Optional · 0.06 to 8 · Defaults to 0.125
        
        encryptionStandard · enum · Optional · Defaults to None
        
        Allowed values: Unsynced, None, AES128, AES192, AES256
        
        passPhrase · object · Optional
        
        One of the following variants:
        
        string (string)
        
        null (null)
        
        payload · object · Optional
        
        One of the following variants:
        
        MptsPayload (object)
        
        programNumber · string · Optional · Defaults to 1
        
        delayMode · enum · Optional · Defaults to Standard
        
        Allowed values: Unsynced, Standard, Low, SuperLow
        
        decrypt · object · Optional
        
        One of the following variants:
        
        DecryptConfig (object)
        
        type · enum · Optional · Defaults to None
        
        Allowed values: Unsynced, None, BISS, BISSCA, DVBCI
        
        bissMode · object · Optional
        
        One of the following variants:
        
        BissMode (enum)
        
        null (null)
        
        bissKey · object · Optional
        
        One of the following variants:
        
        string (string)
        
        null (null)
        
        bissInjectedKeyId · object · Optional
        
        One of the following variants:
        
        string (string)
        
        null (null)
        
        bissCAKeyId · object · Optional
        
        One of the following variants:
        
        string (string)
        
        null (null)
        
        camSlot · object · Optional
        
        One of the following variants:
        
        integer (integer)
        
        null (null)
        
        camPort · object · Optional
        
        One of the following variants:
        
        integer (integer)
        
        null (null)
        
        null (null)
        
        null (null)
        
        UDP (object)
        
        type · string · Optional · Defaults to UDP
        
        name · string · Required
        
        transport · object · Required
        
        url · string · Required
        
        interface · string · Required
        
        unicast · boolean · Optional · Defaults to false
        
        payload · object · Optional
        
        One of the following variants:
        
        MptsPayload (object)
        
        programNumber · string · Optional · Defaults to 1
        
        delayMode · enum · Optional · Defaults to Standard
        
        Allowed values: Unsynced, Standard, Low, SuperLow
        
        decrypt · object · Optional
        
        One of the following variants:
        
        DecryptConfig (object)
        
        type · enum · Optional · Defaults to None
        
        Allowed values: Unsynced, None, BISS, BISSCA, DVBCI
        
        bissMode · object · Optional
        
        One of the following variants:
        
        BissMode (enum)
        
        null (null)
        
        bissKey · object · Optional
        
        One of the following variants:
        
        string (string)
        
        null (null)
        
        bissInjectedKeyId · object · Optional
        
        One of the following variants:
        
        string (string)
        
        null (null)
        
        bissCAKeyId · object · Optional
        
        One of the following variants:
        
        string (string)
        
        null (null)
        
        camSlot · object · Optional
        
        One of the following variants:
        
        integer (integer)
        
        null (null)
        
        camPort · object · Optional
        
        One of the following variants:
        
        integer (integer)
        
        null (null)
        
        null (null)
        
        null (null)
        
        ASI (object)
        
        type · string · Optional · Defaults to ASI
        
        name · string · Required
        
        transport · object · Required
        
        url · string · Required · pattern: ^asi://
        
        tsPacketSize · object · Optional
        
        One of the following variants:
        
        TsPacketSize (enum)
        
        null (null)
        
        payload · object · Optional
        
        One of the following variants:
        
        MptsPayload (object)
        
        programNumber · string · Optional · Defaults to 1
        
        delayMode · enum · Optional · Defaults to Standard
        
        Allowed values: Unsynced, Standard, Low, SuperLow
        
        decrypt · object · Optional
        
        One of the following variants:
        
        DecryptConfig (object)
        
        type · enum · Optional · Defaults to None
        
        Allowed values: Unsynced, None, BISS, BISSCA, DVBCI
        
        bissMode · object · Optional
        
        One of the following variants:
        
        BissMode (enum)
        
        null (null)
        
        bissKey · object · Optional
        
        One of the following variants:
        
        string (string)
        
        null (null)
        
        bissInjectedKeyId · object · Optional
        
        One of the following variants:
        
        string (string)
        
        null (null)
        
        bissCAKeyId · object · Optional
        
        One of the following variants:
        
        string (string)
        
        null (null)
        
        camSlot · object · Optional
        
        One of the following variants:
        
        integer (integer)
        
        null (null)
        
        camPort · object · Optional
        
        One of the following variants:
        
        integer (integer)
        
        null (null)
        
        null (null)
        
        null (null)
        
        SatDemod (object)
        
        type · string · Optional · Defaults to SatDemod
        
        name · string · Required
        
        transport · object · Required
        
        url · string · Required · pattern: ^rfdemod://
        
        lnbFrequencyMHz · integer · Required
        
        lnbVoltage · enum · Optional · Defaults to Off
        
        Allowed values: Unsynced, Off, 13V, 18V
        
        lnbToneEnabled · boolean · Optional · Defaults to false
        
        tunerFrequencyHz · integer · Required
        
        tunerSymbolRate · integer · Required
        
        tunerSearchRangeHz · integer · Optional · Defaults to 2000000
        
        tunerMISEnabled · boolean · Optional · Defaults to false
        
        tunerGoldCode · integer · Optional · Defaults to 0
        
        tunerMISStreamId · object · Optional
        
        One of the following variants:
        
        integer (integer)
        
        null (null)
        
        payload · object · Optional
        
        One of the following variants:
        
        MptsPayload (object)
        
        programNumber · string · Optional · Defaults to 1
        
        delayMode · enum · Optional · Defaults to Standard
        
        Allowed values: Unsynced, Standard, Low, SuperLow
        
        decrypt · object · Optional
        
        One of the following variants:
        
        DecryptConfig (object)
        
        type · enum · Optional · Defaults to None
        
        Allowed values: Unsynced, None, BISS, BISSCA, DVBCI
        
        bissMode · object · Optional
        
        One of the following variants:
        
        BissMode (enum)
        
        null (null)
        
        bissKey · object · Optional
        
        One of the following variants:
        
        string (string)
        
        null (null)
        
        bissInjectedKeyId · object · Optional
        
        One of the following variants:
        
        string (string)
        
        null (null)
        
        bissCAKeyId · object · Optional
        
        One of the following variants:
        
        string (string)
        
        null (null)
        
        camSlot · object · Optional
        
        One of the following variants:
        
        integer (integer)
        
        null (null)
        
        camPort · object · Optional
        
        One of the following variants:
        
        integer (integer)
        
        null (null)
        
        null (null)
        
        null (null)
        
        Smpte2110 (object)
        
        type · string · Optional · Defaults to Smpte2110
        
        name · string · Required
        
        transport · object · Required
        
        interface · object · Optional
        
        One of the following variants:
        
        string (string)
        
        null (null)
        
        nmosEnabled · boolean · Optional · Defaults to false
        
        payload · object · Optional
        
        One of the following variants:
        
        Smpte2110Payload (object)
        
        video · object · Optional
        
        One of the following variants:
        
        Smpte2110VideoInputEssence (object)
        
        type · string · Optional · Defaults to video
        
        transportFile · object · Optional
        
        One of the following variants:
        
        TransportFile (object)
        
        data · string · Required — Raw file contents; expects SDP format by default.
        
        null (null)
        
        sdpUrl · object · Optional
        
        One of the following variants:
        
        string (string)
        
        null (null)
        
        streamIndex · integer · Optional · >=0 · Defaults to 0
        
        null (null)
        
        audios · list of objects · Optional · Defaults to []
        
        Array items (object):
        
        type · string · Optional · Defaults to audio
        
        transportFile · object · Optional
        
        One of the following variants:
        
        TransportFile (object)
        
        data · string · Required — Raw file contents; expects SDP format by default.
        
        null (null)
        
        sdpUrl · object · Optional
        
        One of the following variants:
        
        string (string)
        
        null (null)
        
        streamIndex · integer · Optional · >=0 · Defaults to 0
        
        channelGroupIndex · integer · Optional · >=0 · Defaults to 0
        
        name · object · Optional
        
        One of the following variants:
        
        string (string)
        
        null (null)
        
        null (null)
        
        SDI (object)
        
        type · string · Optional · Defaults to SDI
        
        name · string · Required
        
        transport · object · Required
        
        url · string · Required · pattern: ^sdi://
        
        payload · object · Optional
        
        One of the following variants:
        
        SdiPayload (object)
        
        audios · list of objects · Optional · Defaults to []
        
        Array items (object):
        
        name · string · Required
        
        aggregation · object · Optional · Defaults to {"type":"None","pair":"G1P1"}
        
        One of the following variants, selected by type:
        
        None (object)
        
        type · string · Optional · Defaults to None
        
        pair · enum · Required · Defaults to G1P1
        
        Allowed values: Unsynced, G1P1, G1P2, G2P1, G2P2, G3P1, G3P2, G4P1, G4P2
        
        null (null)
        
        Unsynced (object)
        
        type · string · Optional · Defaults to Unsynced
        
        name · string · Required
        
        unsupportedValue · string · Optional · _Defaults to _
      - transform · object · Optional
        
        One of the following variants:
        
        TransformConfig (object)
        
        encoding · object · Optional
        
        One of the following variants:
        
        EncodingConfig (object)
        
        video · object · Required
        
        codec · enum · Required · Defaults to H264High
        
        Allowed values: Unsynced, HEVCMain, HEVCMain10bit, HEVCMain422, HEVCMain10bit422, H264Main, H264High, H264High422, H264High10bit, H264High10bit422, H264Baseline, MPEG2, MPEG2422, JPEGXS, JPEGXS10bit
        
        videoFormat · enum · Required · Defaults to 1920x1080p
        
        Allowed values: Unsynced, 3840x2160p, 1920x1080p, 1920x1080i, 1440x1080p, 1440x1080i, 1280x1080p, 1280x1080i, 960x1080p, 960x1080i, 1280x720p, 960x720p, 854x720p, 848x720p, 640x720p, 720x576p, 720x576i, 704x576p, 704x576i, 544x576p, 544x576i, 528x576p, 528x576i, 480x576p, 480x576i, 352x576p, 352x576i, 720x480p, 720x480i, 704x480p, 704x480i, 640x480p, 640x480i, 544x480p, 544x480i, 528x480p, 528x480i, 480x480p, 480x480i, 352x480p, 352x480i, 352x288p, 320x240p, 192x192p, 176x144p, 176x120p, 128x96p, 96x96p
        
        bitrate · integer · Required · 100000 to 60000000 · Defaults to 6000000
        
        frameRate · object · Optional · Defaults to TrueMotion
        
        One of the following variants:
        
        FrameRate (enum)
        
        null (null)
        
        audios · list of objects · Optional · Defaults to []
        
        Array items (object):
        
        name · object · Optional
        
        One of the following variants:
        
        string (string)
        
        null (null)
        
        inputName · object · Optional
        
        One of the following variants:
        
        string (string)
        
        null (null)
        
        audioName · object · Optional
        
        One of the following variants:
        
        string (string)
        
        null (null)
        
        codec · enum · Required · Defaults to AC3
        
        Allowed values: Unsynced, PassThrough, SMPTE302PassThrough, MPEG1Layer2, AAC, HEAAC, HEAACv2, AC3, EAC3, AC4
        
        mode · object · Optional · Defaults to Stereo
        
        One of the following variants:
        
        AudioMode (enum)
        
        null (null)
        
        bitrate · object · Optional · Defaults to 192000
        
        One of the following variants:
        
        AudioBitrate (enum)
        
        null (null)
        
        ac4Config · object · Optional
        
        One of the following variants:
        
        Ac4Config (object)
        
        frameRate · string · Optional · Defaults to 25
        
        language · string · Optional · Defaults to auto
        
        contentClassifier · enum · Optional · Defaults to classCompleteMain
        
        Allowed values: Unsynced, classCompleteMain, classEmergency, classMusicEffect, classMainAssociatedMix
        
        null (null)
        
        null (null)
        
        abrEncoding · object · Optional
        
        One of the following variants:
        
        AbrEncodingConfig (object)
        
        representations · list of objects · Optional · Defaults to []
        
        Array items (object):
        
        video · object · Required
        
        codec · enum · Required · Defaults to H264High
        
        Allowed values: Unsynced, HEVCMain, HEVCMain10bit, HEVCMain422, HEVCMain10bit422, H264Main, H264High, H264High422, H264High10bit, H264High10bit422, H264Baseline, MPEG2, MPEG2422, JPEGXS, JPEGXS10bit
        
        videoFormat · enum · Required · Defaults to 1920x1080p
        
        Allowed values: Unsynced, 3840x2160p, 1920x1080p, 1920x1080i, 1440x1080p, 1440x1080i, 1280x1080p, 1280x1080i, 960x1080p, 960x1080i, 1280x720p, 960x720p, 854x720p, 848x720p, 640x720p, 720x576p, 720x576i, 704x576p, 704x576i, 544x576p, 544x576i, 528x576p, 528x576i, 480x576p, 480x576i, 352x576p, 352x576i, 720x480p, 720x480i, 704x480p, 704x480i, 640x480p, 640x480i, 544x480p, 544x480i, 528x480p, 528x480i, 480x480p, 480x480i, 352x480p, 352x480i, 352x288p, 320x240p, 192x192p, 176x144p, 176x120p, 128x96p, 96x96p
        
        bitrate · integer · Required · 100000 to 60000000 · Defaults to 6000000
        
        frameRate · object · Optional · Defaults to TrueMotion
        
        One of the following variants:
        
        FrameRate (enum)
        
        null (null)
        
        audios · list of objects · Optional · Defaults to []
        
        Array items (object):
        
        name · object · Optional
        
        One of the following variants:
        
        string (string)
        
        null (null)
        
        inputName · object · Optional
        
        One of the following variants:
        
        string (string)
        
        null (null)
        
        audioName · object · Optional
        
        One of the following variants:
        
        string (string)
        
        null (null)
        
        codec · enum · Required · Defaults to AC3
        
        Allowed values: Unsynced, PassThrough, SMPTE302PassThrough, MPEG1Layer2, AAC, HEAAC, HEAACv2, AC3, EAC3, AC4
        
        mode · object · Optional · Defaults to Stereo
        
        One of the following variants:
        
        AudioMode (enum)
        
        null (null)
        
        bitrate · object · Optional · Defaults to 192000
        
        One of the following variants:
        
        AudioBitrate (enum)
        
        null (null)
        
        ac4Config · object · Optional
        
        One of the following variants:
        
        Ac4Config (object)
        
        frameRate · string · Optional · Defaults to 25
        
        language · string · Optional · Defaults to auto
        
        contentClassifier · enum · Optional · Defaults to classCompleteMain
        
        Allowed values: Unsynced, classCompleteMain, classEmergency, classMusicEffect, classMainAssociatedMix
        
        null (null)
        
        null (null)
        
        multiplexing · object · Optional
        
        One of the following variants:
        
        MultiplexingConfig (object)
        
        enabled · boolean · Optional · Defaults to false
        
        null (null)
        
        null (null)
      - outputs · list of objects · Optional · Defaults to []
        
        Array items (object):
        
        One of the following variants, selected by type:
        
        SRTCaller (object)
        
        type · string · Optional · Defaults to SRTCaller
        
        transport · object · Required
        
        url · string · Required · pattern: ^srt://
        
        interface · object · Optional
        
        One of the following variants:
        
        string (string)
        
        null (null)
        
        latency · double · Optional · 0.06 to 8 · Defaults to 0.125
        
        encryptionStandard · enum · Optional · Defaults to None
        
        Allowed values: Unsynced, None, AES128, AES192, AES256
        
        passPhrase · object · Optional
        
        One of the following variants:
        
        string (string)
        
        null (null)
        
        SRTListener (object)
        
        type · string · Optional · Defaults to SRTListener
        
        transport · object · Required
        
        interface · string · Required
        
        port · integer · Required · 256 to 65535 — Port number
        
        maxConnections · integer · Optional · >=1 · Defaults to 10
        
        latency · double · Optional · 0.06 to 8 · Defaults to 0.125
        
        encryptionStandard · enum · Optional · Defaults to None
        
        Allowed values: Unsynced, None, AES128, AES192, AES256
        
        passPhrase · object · Optional
        
        One of the following variants:
        
        string (string)
        
        null (null)
        
        UDP (object)
        
        type · string · Optional · Defaults to UDP
        
        transport · object · Required
        
        url · string · Required
        
        interface · string · Required
        
        sourceAddress · object · Optional
        
        One of the following variants:
        
        string (string)
        
        null (null)
        
        sourcePort · object · Optional
        
        One of the following variants:
        
        integer (integer)
        
        null (null)
        
        ASI (object)
        
        type · string · Optional · Defaults to ASI
        
        name · object · Optional
        
        One of the following variants:
        
        string (string)
        
        null (null)
        
        transport · object · Required
        
        url · string · Required · pattern: ^asi://
        
        RF (object)
        
        type · string · Optional · Defaults to RF
        
        transport · object · Required
        
        url · string · Required · pattern: ^satmod://
        
        SDI (object)
        
        type · string · Optional · Defaults to SDI
        
        transport · object · Required
        
        url · string · Required · pattern: ^sdi://
        
        processing · object · Optional
        
        One of the following variants:
        
        OutputProcessing (object)
        
        videoScaling · enum · Optional · Defaults to None
        
        Allowed values: Unsynced, None, 1080i
        
        dynamicRangeConversion · enum · Optional · Defaults to None
        
        Allowed values: Unsynced, None, BT709
        
        null (null)
        
        HttpStreaming (object)
        
        type · string · Optional · Defaults to HttpStreaming
        
        Smpte2110 (object)
        
        type · string · Optional · Defaults to Smpte2110
        
        transport · object · Required
        
        interface · object · Optional
        
        One of the following variants:
        
        string (string)
        
        null (null)
        
        nmosEnabled · boolean · Optional · Defaults to false
        
        processing · object · Optional
        
        One of the following variants:
        
        OutputProcessing (object)
        
        videoScaling · enum · Optional · Defaults to None
        
        Allowed values: Unsynced, None, 1080i
        
        dynamicRangeConversion · enum · Optional · Defaults to None
        
        Allowed values: Unsynced, None, BT709
        
        null (null)
        
        payload · object · Optional
        
        One of the following variants:
        
        Smpte2110OutputEssences (object)
        
        video · object · Required
        
        interface · string · Required
        
        destinationAddress · string · Required · format: ipv4
        
        destinationPort · integer · Required · 1024 to 65535 — Port number
        
        sourcePort · integer · Required · 1 to 65535 — Port number
        
        audios · list of objects · Optional · Defaults to []
        
        Array items (object):
        
        interface · string · Required
        
        destinationPort · integer · Required · 1024 to 65535 — Port number
        
        sourcePort · integer · Required · 1 to 65535 — Port number
        
        null (null)
        
        Unsynced (object)
        
        type · string · Optional · Defaults to Unsynced
        
        unsupportedValue · string · Optional · _Defaults to _
    - services · list of objects · Optional
      - Array items (object):
        
        name · string · Required
        
        type · string · Required
        
        id · string · Required
        
        config · object · Required
        
        configVersion · string · Required
mode · enum · Optional · Defaults to merge
- Allowed values: merge, replace
state · object · Optional
- One of the following variants:
  - DesiredState (enum)
  - null (null)

Example request

curl -X POST "/ui/connectors/channels-api/latest/import/" \
  -H "Content-Type: application/json" \
  -d '{
  "payload": {
    "schemaVersion": "1",
    "description": "string",
    "exportedAt": "2024-01-01T00:00:00Z",
    "sourceVersion": "string",
    "channels": [
      {
        "kind": "BeamChannel",
        "metadata": {
          "name": "string",
          "displayName": "string"
        },
        "spec": {
          "type": "EncodingContribution",
          "state": "Stopped",
          "inputs": [],
          "transform": {
            "encoding": {
              "video": {
                "codec": "H264High",
                "videoFormat": "1920x1080p",
                "bitrate": 6000000,
                "frameRate": "TrueMotion"
              },
              "audios": []
            },
            "abrEncoding": {
              "representations": [],
              "sharedAudios": []
            },
            "multiplexing": {
              "enabled": false
            }
          },
          "outputs": []
        },
        "services": [
          {
            "name": "string",
            "type": "string",
            "id": "string",
            "config": {},
            "configVersion": "string"
          }
        ]
      }
    ]
  },
  "mode": "merge",
  "state": "Running"
}'

Responses

200 — Successful Response

imported · list of objects · Optional
- Array items (object):
  - name · string · Required
  - sourceName · string · Required
  - displayName · string · Required
  - status · enum · Required
    - Allowed values: accepted, skipped, rejected
  - error · object · Optional
    - One of the following variants:
      - string (string)
      - null (null)
deleted · list of strings · Optional
- Array items (string):
errors · list of strings · Optional
- Array items (string):
warnings · list of strings · Optional
- Array items (string):

Example:

{
  "imported": [
    {
      "name": "string",
      "sourceName": "string",
      "displayName": "string",
      "status": "accepted",
      "error": "string"
    }
  ],
  "deleted": [
    "string"
  ],
  "errors": [
    "string"
  ],
  "warnings": [
    "string"
  ]
}

422 — Validation Error

detail · list of objects · Optional
- Array items (object):
  - loc · list of objects · Required
    - Array items (object):
      - One of the following variants:
        
        string (string)
        
        integer (integer)
  - msg · string · Required
  - type · string · Required
  - input · any · Optional
  - ctx · object · Optional

Example:

{
  "detail": [
    {
      "loc": [
        "string"
      ],
      "msg": "string",
      "type": "string",
      "input": null,
      "ctx": {}
    }
  ]
}