Channel Import

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

This endpoint expects an object.

payloadobjectExportPayloadRequired
Show 5 propertiesHide 5 properties
schemaVersionstringOptionalDefaults to 1
descriptionobjectOptional
Show 2 variantsHide 2 variants
stringstring

Variant 1: string

nullnull

Variant 2: null

exportedAtstringRequiredformat: date-time
sourceVersionobjectOptional
Show 2 variantsHide 2 variants
stringstring

Variant 1: string

nullnull

Variant 2: null

channelslist of objectsExportedChannelRequired
Show 4 propertiesHide 4 properties
kindstringOptionalDefaults to BeamChannel
metadataobjectChannelMetadataRequired
Show 2 propertiesHide 2 properties
namestringRequired
displayNamestringRequired
specobjectChannelSpecRequired
Show 5 propertiesHide 5 properties
typeenumChannelTypeRequired
Allowed values:EncodingContributionEncodingDistributionReceptionDecodingReceptionGatewayEncodingStreaming
stateenumDesiredStateOptionalDefaults to Stopped
Allowed values:RunningStopped
inputslist of objectsOptionalDefaults to []
Show 8 variantsHide 8 variants

Discriminated by type. Select one variant:

SRTCallerobjectSrtCallerInput
typestringOptionalDefaults to SRTCaller
namestringRequired
transportobjectSrtCallerTransportRequired
Show 5 propertiesHide 5 properties
urlstringRequiredpattern: ^srt://
interfaceobjectOptional
Show 2 variantsHide 2 variants
stringstring

Variant 1: string

nullnull

Variant 2: null

latencydoubleOptional0.06 to 8Defaults to 0.125
encryptionStandardenumSrtEncryptionStandardOptionalDefaults to None
Allowed values:UnsyncedNoneAES128AES192AES256
passPhraseobjectOptional
Show 2 variantsHide 2 variants
stringstring

Variant 1: string

nullnull

Variant 2: null

payloadobjectOptional
Show 2 variantsHide 2 variants
MptsPayloadobject
programNumberstringOptionalDefaults to 1
delayModeenumDelayModeOptionalDefaults to Standard
Allowed values:UnsyncedStandardLowSuperLow
decryptobjectOptional
Show 2 variantsHide 2 variants
DecryptConfigobject
typeenumDecryptTypeOptionalDefaults to None
Allowed values:UnsyncedNoneBISSBISSCADVBCI
bissModeobjectOptional
Show 2 variantsHide 2 variants
BissModeenum

Variant 1: enum

nullnull

Variant 2: null

bissKeyobjectOptional
Show 2 variantsHide 2 variants
stringstring

Variant 1: string

nullnull

Variant 2: null

bissInjectedKeyIdobjectOptional
Show 2 variantsHide 2 variants
stringstring

Variant 1: string

nullnull

Variant 2: null

bissCAKeyIdobjectOptional
Show 2 variantsHide 2 variants
stringstring

Variant 1: string

nullnull

Variant 2: null

camSlotobjectOptional
Show 2 variantsHide 2 variants
integerinteger

Variant 1: integer

nullnull

Variant 2: null

camPortobjectOptional
Show 2 variantsHide 2 variants
integerinteger

Variant 1: integer

nullnull

Variant 2: null

nullnull

Variant 2: null

nullnull

Variant 2: null

SRTListenerobjectSrtListenerInput
typestringOptionalDefaults to SRTListener
namestringRequired
transportobjectSrtListenerTransportRequired
Show 6 propertiesHide 6 properties
interfacestringRequired
portintegerRequired256 to 65535
Port number
maxConnectionsintegerOptional>=1Defaults to 10
latencydoubleOptional0.06 to 8Defaults to 0.125
encryptionStandardenumSrtEncryptionStandardOptionalDefaults to None
Allowed values:UnsyncedNoneAES128AES192AES256
passPhraseobjectOptional
Show 2 variantsHide 2 variants
stringstring

Variant 1: string

nullnull

Variant 2: null

payloadobjectOptional
Show 2 variantsHide 2 variants
MptsPayloadobject
programNumberstringOptionalDefaults to 1
delayModeenumDelayModeOptionalDefaults to Standard
Allowed values:UnsyncedStandardLowSuperLow
decryptobjectOptional
Show 2 variantsHide 2 variants
DecryptConfigobject
typeenumDecryptTypeOptionalDefaults to None
Allowed values:UnsyncedNoneBISSBISSCADVBCI
bissModeobjectOptional
Show 2 variantsHide 2 variants
BissModeenum

Variant 1: enum

nullnull

Variant 2: null

bissKeyobjectOptional
Show 2 variantsHide 2 variants
stringstring

Variant 1: string

nullnull

Variant 2: null

bissInjectedKeyIdobjectOptional
Show 2 variantsHide 2 variants
stringstring

Variant 1: string

nullnull

Variant 2: null

bissCAKeyIdobjectOptional
Show 2 variantsHide 2 variants
stringstring

Variant 1: string

nullnull

Variant 2: null

camSlotobjectOptional
Show 2 variantsHide 2 variants
integerinteger

Variant 1: integer

nullnull

Variant 2: null

camPortobjectOptional
Show 2 variantsHide 2 variants
integerinteger

Variant 1: integer

nullnull

Variant 2: null

nullnull

Variant 2: null

nullnull

Variant 2: null

UDPobjectUdpInput
typestringOptionalDefaults to UDP
namestringRequired
transportobjectUdpTransportRequired
Show 3 propertiesHide 3 properties
urlstringRequired
interfacestringRequired
unicastbooleanOptionalDefaults to false
payloadobjectOptional
Show 2 variantsHide 2 variants
MptsPayloadobject
programNumberstringOptionalDefaults to 1
delayModeenumDelayModeOptionalDefaults to Standard
Allowed values:UnsyncedStandardLowSuperLow
decryptobjectOptional
Show 2 variantsHide 2 variants
DecryptConfigobject
typeenumDecryptTypeOptionalDefaults to None
Allowed values:UnsyncedNoneBISSBISSCADVBCI
bissModeobjectOptional
Show 2 variantsHide 2 variants
BissModeenum

Variant 1: enum

nullnull

Variant 2: null

bissKeyobjectOptional
Show 2 variantsHide 2 variants
stringstring

Variant 1: string

nullnull

Variant 2: null

bissInjectedKeyIdobjectOptional
Show 2 variantsHide 2 variants
stringstring

Variant 1: string

nullnull

Variant 2: null

bissCAKeyIdobjectOptional
Show 2 variantsHide 2 variants
stringstring

Variant 1: string

nullnull

Variant 2: null

camSlotobjectOptional
Show 2 variantsHide 2 variants
integerinteger

Variant 1: integer

nullnull

Variant 2: null

camPortobjectOptional
Show 2 variantsHide 2 variants
integerinteger

Variant 1: integer

nullnull

Variant 2: null

nullnull

Variant 2: null

nullnull

Variant 2: null

ASIobjectAsiInput
typestringOptionalDefaults to ASI
namestringRequired
transportobjectAsiInputTransportRequired
Show 2 propertiesHide 2 properties
urlstringRequiredpattern: ^asi://
tsPacketSizeobjectOptional
Show 2 variantsHide 2 variants
TsPacketSizeenum

Variant 1: enum

nullnull

Variant 2: null

payloadobjectOptional
Show 2 variantsHide 2 variants
MptsPayloadobject
programNumberstringOptionalDefaults to 1
delayModeenumDelayModeOptionalDefaults to Standard
Allowed values:UnsyncedStandardLowSuperLow
decryptobjectOptional
Show 2 variantsHide 2 variants
DecryptConfigobject
typeenumDecryptTypeOptionalDefaults to None
Allowed values:UnsyncedNoneBISSBISSCADVBCI
bissModeobjectOptional
Show 2 variantsHide 2 variants
BissModeenum

Variant 1: enum

nullnull

Variant 2: null

bissKeyobjectOptional
Show 2 variantsHide 2 variants
stringstring

Variant 1: string

nullnull

Variant 2: null

bissInjectedKeyIdobjectOptional
Show 2 variantsHide 2 variants
stringstring

Variant 1: string

nullnull

Variant 2: null

bissCAKeyIdobjectOptional
Show 2 variantsHide 2 variants
stringstring

Variant 1: string

nullnull

Variant 2: null

camSlotobjectOptional
Show 2 variantsHide 2 variants
integerinteger

Variant 1: integer

nullnull

Variant 2: null

camPortobjectOptional
Show 2 variantsHide 2 variants
integerinteger

Variant 1: integer

nullnull

Variant 2: null

nullnull

Variant 2: null

nullnull

Variant 2: null

SatDemodobjectSatDemodInput
typestringOptionalDefaults to SatDemod
namestringRequired
transportobjectSatDemodTransportRequired
Show 10 propertiesHide 10 properties
urlstringRequiredpattern: ^rfdemod://
lnbFrequencyMHzintegerRequired
lnbVoltageenumLnbVoltageOptionalDefaults to Off
Allowed values:UnsyncedOff13V18V
lnbToneEnabledbooleanOptionalDefaults to false
tunerFrequencyHzintegerRequired
tunerSymbolRateintegerRequired
tunerSearchRangeHzintegerOptionalDefaults to 2000000
tunerMISEnabledbooleanOptionalDefaults to false
tunerGoldCodeintegerOptionalDefaults to 0
tunerMISStreamIdobjectOptional
Show 2 variantsHide 2 variants
integerinteger

Variant 1: integer

nullnull

Variant 2: null

payloadobjectOptional
Show 2 variantsHide 2 variants
MptsPayloadobject
programNumberstringOptionalDefaults to 1
delayModeenumDelayModeOptionalDefaults to Standard
Allowed values:UnsyncedStandardLowSuperLow
decryptobjectOptional
Show 2 variantsHide 2 variants
DecryptConfigobject
typeenumDecryptTypeOptionalDefaults to None
Allowed values:UnsyncedNoneBISSBISSCADVBCI
bissModeobjectOptional
Show 2 variantsHide 2 variants
BissModeenum

Variant 1: enum

nullnull

Variant 2: null

bissKeyobjectOptional
Show 2 variantsHide 2 variants
stringstring

Variant 1: string

nullnull

Variant 2: null

bissInjectedKeyIdobjectOptional
Show 2 variantsHide 2 variants
stringstring

Variant 1: string

nullnull

Variant 2: null

bissCAKeyIdobjectOptional
Show 2 variantsHide 2 variants
stringstring

Variant 1: string

nullnull

Variant 2: null

camSlotobjectOptional
Show 2 variantsHide 2 variants
integerinteger

Variant 1: integer

nullnull

Variant 2: null

camPortobjectOptional
Show 2 variantsHide 2 variants
integerinteger

Variant 1: integer

nullnull

Variant 2: null

nullnull

Variant 2: null

nullnull

Variant 2: null

Smpte2110objectSmpte2110Input
typestringOptionalDefaults to Smpte2110
namestringRequired
transportobjectSmpte2110InputTransportRequired
Show 2 propertiesHide 2 properties
interfaceobjectOptional
Show 2 variantsHide 2 variants
stringstring

Variant 1: string

nullnull

Variant 2: null

nmosEnabledbooleanOptionalDefaults to false
payloadobjectOptional
Show 2 variantsHide 2 variants
Smpte2110Payloadobject
videoobjectOptional
Show 2 variantsHide 2 variants
Smpte2110VideoInputEssenceobject
typestringOptionalDefaults to video
transportFileobjectOptional
Show 2 variantsHide 2 variants
TransportFileobject
SDP transport file for an ST 2110 stream.
datastringRequired
Raw file contents; expects SDP format by default.
nullnull

Variant 2: null

sdpUrlobjectOptional
Show 2 variantsHide 2 variants
stringstring

Variant 1: string

nullnull

Variant 2: null

streamIndexintegerOptional>=0Defaults to 0
nullnull

Variant 2: null

audioslist of objectsSmpte2110AudioInputEssenceOptionalDefaults to []
Show 6 propertiesHide 6 properties
typestringOptionalDefaults to audio
transportFileobjectOptional
Show 2 variantsHide 2 variants
TransportFileobject
SDP transport file for an ST 2110 stream.
datastringRequired
Raw file contents; expects SDP format by default.
nullnull

Variant 2: null

sdpUrlobjectOptional
Show 2 variantsHide 2 variants
stringstring

Variant 1: string

nullnull

Variant 2: null

streamIndexintegerOptional>=0Defaults to 0
channelGroupIndexintegerOptional>=0Defaults to 0
nameobjectOptional
Show 2 variantsHide 2 variants
stringstring

Variant 1: string

nullnull

Variant 2: null

nullnull

Variant 2: null

SDIobjectSdiInput
typestringOptionalDefaults to SDI
namestringRequired
transportobjectSdiInputTransportRequired
Show 1 propertyHide 1 property
urlstringRequiredpattern: ^sdi://
payloadobjectOptional
Show 2 variantsHide 2 variants
SdiPayloadobject
audioslist of objectsSdiAudioInputOptionalDefaults to []
Show 2 propertiesHide 2 properties
namestringRequired
aggregationobjectOptionalDefaults to {"type":"None","pair":"G1P1"}
Show 1 variantHide 1 variant

Discriminated by type. Select one variant:

NoneobjectSdiNoAggregation
typestringOptionalDefaults to None
pairenumSdiAudioPairRequiredDefaults to G1P1
Allowed values:UnsyncedG1P1G1P2G2P1G2P2G3P1G3P2G4P1G4P2
nullnull

Variant 2: null

UnsyncedobjectUnsyncedInput
Input synced from a service config whose transport mode this version of the schema does not implement. unsupportedValue is the discriminator value that triggered it (e.g. "ristListener"). Read/display only — a channel containing one cannot be deployed.
typestringOptionalDefaults to Unsynced
namestringRequired
unsupportedValuestringOptionalDefaults to
transformobjectOptional
Show 2 variantsHide 2 variants
TransformConfigobject
encodingobjectOptional
Show 2 variantsHide 2 variants
EncodingConfigobject
videoobjectVideoEncodingRequired
Show 4 propertiesHide 4 properties
codecenumVideoCodecRequiredDefaults to H264High
Allowed values:UnsyncedHEVCMainHEVCMain10bitHEVCMain422HEVCMain10bit422H264MainH264HighH264High422H264High10bitH264High10bit422H264BaselineMPEG2MPEG2422JPEGXSJPEGXS10bit
videoFormatenumVideoFormatRequiredDefaults to 1920x1080p
Allowed values:Unsynced3840x2160p1920x1080p1920x1080i1440x1080p1440x1080i1280x1080p1280x1080i960x1080p960x1080i1280x720p960x720p854x720p848x720p640x720p720x576p720x576i704x576p704x576i544x576p544x576i528x576p528x576i480x576p480x576i352x576p352x576i720x480p720x480i704x480p704x480i640x480p640x480i544x480p544x480i528x480p528x480i480x480p480x480i352x480p352x480i352x288p320x240p192x192p176x144p176x120p128x96p96x96p
bitrateintegerRequired100000 to 60000000Defaults to 6000000
frameRateobjectOptionalDefaults to TrueMotion
Show 2 variantsHide 2 variants
FrameRateenum

Variant 1: enum

nullnull

Variant 2: null

audioslist of objectsAudioEncodingOptionalDefaults to []
Show 7 propertiesHide 7 properties
nameobjectOptional
Show 2 variantsHide 2 variants
stringstring

Variant 1: string

nullnull

Variant 2: null

inputNameobjectOptional
Show 2 variantsHide 2 variants
stringstring

Variant 1: string

nullnull

Variant 2: null

audioNameobjectOptional
Show 2 variantsHide 2 variants
stringstring

Variant 1: string

nullnull

Variant 2: null

codecenumAudioCodecRequiredDefaults to AC3
Allowed values:UnsyncedPassThroughSMPTE302PassThroughMPEG1Layer2AACHEAACHEAACv2AC3EAC3AC4
modeobjectOptionalDefaults to Stereo
Show 2 variantsHide 2 variants
AudioModeenum

Variant 1: enum

nullnull

Variant 2: null

bitrateobjectOptionalDefaults to 192000
Show 2 variantsHide 2 variants
AudioBitrateenum

Variant 1: enum

nullnull

Variant 2: null

ac4ConfigobjectOptional
Show 2 variantsHide 2 variants
Ac4Configobject
frameRatestringOptionalDefaults to 25
languagestringOptionalDefaults to auto
contentClassifierenumAc4ContentClassifierOptionalDefaults to classCompleteMain
Allowed values:UnsyncedclassCompleteMainclassEmergencyclassMusicEffectclassMainAssociatedMix
nullnull

Variant 2: null

nullnull

Variant 2: null

abrEncodingobjectOptional
Show 2 variantsHide 2 variants
AbrEncodingConfigobject
representationslist of objectsRepresentationOptionalDefaults to []
Show 2 propertiesHide 2 properties
videoobjectVideoEncodingRequired
Show 4 propertiesHide 4 properties
codecenumVideoCodecRequiredDefaults to H264High
Allowed values:UnsyncedHEVCMainHEVCMain10bitHEVCMain422HEVCMain10bit422H264MainH264HighH264High422H264High10bitH264High10bit422H264BaselineMPEG2MPEG2422JPEGXSJPEGXS10bit
videoFormatenumVideoFormatRequiredDefaults to 1920x1080p
Allowed values:Unsynced3840x2160p1920x1080p1920x1080i1440x1080p1440x1080i1280x1080p1280x1080i960x1080p960x1080i1280x720p960x720p854x720p848x720p640x720p720x576p720x576i704x576p704x576i544x576p544x576i528x576p528x576i480x576p480x576i352x576p352x576i720x480p720x480i704x480p704x480i640x480p640x480i544x480p544x480i528x480p528x480i480x480p480x480i352x480p352x480i352x288p320x240p192x192p176x144p176x120p128x96p96x96p
bitrateintegerRequired100000 to 60000000Defaults to 6000000
frameRateobjectOptionalDefaults to TrueMotion
Show 2 variantsHide 2 variants
FrameRateenum

Variant 1: enum

nullnull

Variant 2: null

audioslist of objectsAudioEncodingOptionalDefaults to []
Show 7 propertiesHide 7 properties
nameobjectOptional
Show 2 variantsHide 2 variants
stringstring

Variant 1: string

nullnull

Variant 2: null

inputNameobjectOptional
Show 2 variantsHide 2 variants
stringstring

Variant 1: string

nullnull

Variant 2: null

audioNameobjectOptional
Show 2 variantsHide 2 variants
stringstring

Variant 1: string

nullnull

Variant 2: null

codecenumAudioCodecRequiredDefaults to AC3
Allowed values:UnsyncedPassThroughSMPTE302PassThroughMPEG1Layer2AACHEAACHEAACv2AC3EAC3AC4
modeobjectOptionalDefaults to Stereo
Show 2 variantsHide 2 variants
AudioModeenum

Variant 1: enum

nullnull

Variant 2: null

bitrateobjectOptionalDefaults to 192000
Show 2 variantsHide 2 variants
AudioBitrateenum

Variant 1: enum

nullnull

Variant 2: null

ac4ConfigobjectOptional
Show 2 variantsHide 2 variants
Ac4Configobject
frameRatestringOptionalDefaults to 25
languagestringOptionalDefaults to auto
contentClassifierenumAc4ContentClassifierOptionalDefaults to classCompleteMain
Allowed values:UnsyncedclassCompleteMainclassEmergencyclassMusicEffectclassMainAssociatedMix
nullnull

Variant 2: null

sharedAudioslist of objectsAudioEncodingOptionalDefaults to []
Show 7 propertiesHide 7 properties
nameobjectOptional
Show 2 variantsHide 2 variants
stringstring

Variant 1: string

nullnull

Variant 2: null

inputNameobjectOptional
Show 2 variantsHide 2 variants
stringstring

Variant 1: string

nullnull

Variant 2: null

audioNameobjectOptional
Show 2 variantsHide 2 variants
stringstring

Variant 1: string

nullnull

Variant 2: null

codecenumAudioCodecRequiredDefaults to AC3
Allowed values:UnsyncedPassThroughSMPTE302PassThroughMPEG1Layer2AACHEAACHEAACv2AC3EAC3AC4
modeobjectOptionalDefaults to Stereo
Show 2 variantsHide 2 variants
AudioModeenum

Variant 1: enum

nullnull

Variant 2: null

bitrateobjectOptionalDefaults to 192000
Show 2 variantsHide 2 variants
AudioBitrateenum

Variant 1: enum

nullnull

Variant 2: null

ac4ConfigobjectOptional
Show 2 variantsHide 2 variants
Ac4Configobject
frameRatestringOptionalDefaults to 25
languagestringOptionalDefaults to auto
contentClassifierenumAc4ContentClassifierOptionalDefaults to classCompleteMain
Allowed values:UnsyncedclassCompleteMainclassEmergencyclassMusicEffectclassMainAssociatedMix
nullnull

Variant 2: null

nullnull

Variant 2: null

multiplexingobjectOptional
Show 2 variantsHide 2 variants
MultiplexingConfigobject
enabledbooleanOptionalDefaults to false
nullnull

Variant 2: null

nullnull

Variant 2: null

outputslist of objectsOptionalDefaults to []
Show 9 variantsHide 9 variants

Discriminated by type. Select one variant:

SRTCallerobjectSrtCallerOutput
typestringOptionalDefaults to SRTCaller
transportobjectSrtCallerOutputTransportRequired
Show 5 propertiesHide 5 properties
urlstringRequiredpattern: ^srt://
interfaceobjectOptional
Show 2 variantsHide 2 variants
stringstring

Variant 1: string

nullnull

Variant 2: null

latencydoubleOptional0.06 to 8Defaults to 0.125
encryptionStandardenumSrtEncryptionStandardOptionalDefaults to None
Allowed values:UnsyncedNoneAES128AES192AES256
passPhraseobjectOptional
Show 2 variantsHide 2 variants
stringstring

Variant 1: string

nullnull

Variant 2: null

SRTListenerobjectSrtListenerOutput
typestringOptionalDefaults to SRTListener
transportobjectSrtListenerOutputTransportRequired
Show 6 propertiesHide 6 properties
interfacestringRequired
portintegerRequired256 to 65535
Port number
maxConnectionsintegerOptional>=1Defaults to 10
latencydoubleOptional0.06 to 8Defaults to 0.125
encryptionStandardenumSrtEncryptionStandardOptionalDefaults to None
Allowed values:UnsyncedNoneAES128AES192AES256
passPhraseobjectOptional
Show 2 variantsHide 2 variants
stringstring

Variant 1: string

nullnull

Variant 2: null

UDPobjectUdpOutput
typestringOptionalDefaults to UDP
transportobjectUdpOutputTransportRequired
Show 4 propertiesHide 4 properties
urlstringRequired
interfacestringRequired
sourceAddressobjectOptional
Show 2 variantsHide 2 variants
stringstring

Variant 1: string

nullnull

Variant 2: null

sourcePortobjectOptional
Show 2 variantsHide 2 variants
integerinteger
Port number

Variant 1: integer

nullnull

Variant 2: null

ASIobjectAsiOutput
typestringOptionalDefaults to ASI
nameobjectOptional
Show 2 variantsHide 2 variants
stringstring

Variant 1: string

nullnull

Variant 2: null

transportobjectAsiOutputTransportRequired
Show 1 propertyHide 1 property
urlstringRequiredpattern: ^asi://
RFobjectRfOutput
typestringOptionalDefaults to RF
transportobjectRfOutputTransportRequired
Show 1 propertyHide 1 property
urlstringRequiredpattern: ^satmod://
SDIobjectSdiOutput
typestringOptionalDefaults to SDI
transportobjectSdiOutputTransportRequired
Show 1 propertyHide 1 property
urlstringRequiredpattern: ^sdi://
processingobjectOptional
Show 2 variantsHide 2 variants
OutputProcessingobject
videoScalingenumVideoScalingOptionalDefaults to None
Allowed values:UnsyncedNone1080i
dynamicRangeConversionenumDynamicRangeConversionOptionalDefaults to None
Allowed values:UnsyncedNoneBT709
nullnull

Variant 2: null

HttpStreamingobjectHttpStreamingOutput
typestringOptionalDefaults to HttpStreaming
Smpte2110objectSmpte2110Output
typestringOptionalDefaults to Smpte2110
transportobjectSmpte2110OutputTransportRequired
Show 2 propertiesHide 2 properties
interfaceobjectOptional
Show 2 variantsHide 2 variants
stringstring

Variant 1: string

nullnull

Variant 2: null

nmosEnabledbooleanOptionalDefaults to false
processingobjectOptional
Show 2 variantsHide 2 variants
OutputProcessingobject
videoScalingenumVideoScalingOptionalDefaults to None
Allowed values:UnsyncedNone1080i
dynamicRangeConversionenumDynamicRangeConversionOptionalDefaults to None
Allowed values:UnsyncedNoneBT709
nullnull

Variant 2: null

payloadobjectOptional
Show 2 variantsHide 2 variants
Smpte2110OutputEssencesobject
videoobjectSmpte2110VideoOutputEssenceRequired
Show 4 propertiesHide 4 properties
interfacestringRequired
destinationAddressstringRequiredformat: ipv4
destinationPortintegerRequired1024 to 65535
Port number
sourcePortintegerRequired1 to 65535
Port number
audioslist of objectsSmpte2110AudioOutputEssenceOptionalDefaults to []
Show 3 propertiesHide 3 properties
interfacestringRequired
destinationPortintegerRequired1024 to 65535
Port number
sourcePortintegerRequired1 to 65535
Port number
nullnull

Variant 2: null

UnsyncedobjectUnsyncedOutput
Output counterpart of UnsyncedInput. See UnsyncedInput.
typestringOptionalDefaults to Unsynced
unsupportedValuestringOptionalDefaults to
serviceslist of objectsExportedServiceOptional
Show 5 propertiesHide 5 properties
namestringRequired
typestringRequired
idstringRequired
configobjectRequired
configVersionstringRequired
modeenumImportModeOptionalDefaults to merge
Allowed values:mergereplace
stateobjectOptional
Show 2 variantsHide 2 variants
DesiredStateenum

Variant 1: enum

nullnull

Variant 2: null

Response

200 Successful Response
importedlist of objectsImportedChannelResultOptional
Show 5 propertiesHide 5 properties
namestringRequired
sourceNamestringRequired
displayNamestringRequired
statusenumRequired
Allowed values:acceptedskippedrejected
errorobjectOptional
Show 2 variantsHide 2 variants
stringstring

Variant 1: string

nullnull

Variant 2: null

deletedlist of stringsOptional
errorslist of stringsOptional
warningslist of stringsOptional

Errors

422 Validation Error
detaillist of objectsValidationErrorOptional
Show 5 propertiesHide 5 properties
loclist of objectsRequired
Show 2 variantsHide 2 variants
stringstring

Variant 1: string

integerinteger

Variant 2: integer

msgstringRequired
typestringRequired
inputanyOptional
ctxobjectOptional