Create a complete Mux Service

POST

https://device.example.com/cluster1/vos-api/mux/v1/services

POST

/cluster1/vos-api/mux/v1/services

curl -X POST https://device.example.com/cluster1/vos-api/mux/v1/services \
     -H "Authorization: Bearer <token>" \
     -H "Content-Type: application/json" \
     -d '{}'

{
  "destinations": [
    {
      "destinationProfileId": "string",
      "id": "string",
      "inUse": true,
      "labels": [
        "string"
      ],
      "modifiableByAffiliate": true,
      "name": "string",
      "outputs": [
        {
          "id": "string",
          "outputType": "IP",
          "rank": 1,
          "redundancyMode": "MANDATORY",
          "asiSettings": {
            "port": 1,
            "card": "CARD_1",
            "muteAtStartup": true
          },
          "hspSettings": {
            "hspEndpoint": "string",
            "variantPlaylistFileName": "string",
            "hspEndpointId": "string",
            "publicHspEndpoint": "string"
          },
          "ipSettings": {
            "cloudOutputSettings": {
              "channelId": "string",
              "channelName": "string",
              "pipeId": "string",
              "pipeState": "OFFLINE",
              "protocol": "string",
              "region": "string",
              "regionDisplayName": "string",
              "srtCloudOutputSettings": {
                "bandwidthOverhead": 1,
                "blockingMode": true,
                "encryptionParam": {
                  "encryptionKey": "string",
                  "encryptionType": "AES_128"
                },
                "latency": 1,
                "srtConnectionSettingsList": [
                  {
                    "ipAddress": "string",
                    "ipNetworkAddress": "string",
                    "latency": 1,
                    "port": 1,
                    "srtEncryptionParams": {
                      "encryptionKey": "string",
                      "encryptionType": "AES_128"
                    },
                    "streamId": "string",
                    "streamIndex": 1
                  }
                ],
                "timeout": 1
              },
              "streamCount": 1
            },
            "cloudSourceOutputSettings": {
              "pipeId": "string",
              "protocol": "string",
              "region": "string",
              "regionDisplayName": "string"
            },
            "cloudlinkGroupId": "string",
            "cloudlinkId": "string",
            "ipAddress": "string",
            "ipNetworkAddress": "string",
            "ipPort": 1,
            "labels": [
              "string"
            ],
            "muteAtStartup": true,
            "poolBinding": {
              "complexityIp": "string",
              "complexityPort": 1,
              "divitrackCircuitId": 1,
              "divitrackMaxBitrate": 1,
              "divitrackMinBitrate": 1,
              "divitrackNominalBitrate": 1,
              "divitrackPriority": "VERY_HIGH",
              "divitrackStillImageBitrate": 1,
              "noDivitrack": true,
              "operationMode": "STATMUX_VBR",
              "poolId": "string",
              "stillImageDetectionMode": "DETECTION_OFF"
            },
            "sourcePort": 1,
            "srtOutputSettings": {
              "bandwidthOverhead": 1,
              "blockingMode": true,
              "channelId": "string",
              "channelName": "string",
              "connectionMode": "LISTENER",
              "encryptionParam": {
                "encryptionKey": "string",
                "encryptionType": "AES_128"
              },
              "endpointSettings": [
                {
                  "zixiEndpointId": "string"
                }
              ],
              "latency": 1,
              "streamId": "string",
              "timeout": 1
            },
            "zixiOutputSettings": {
              "channelId": "string",
              "channelName": "string",
              "encryptionParam": {
                "encryptionKey": "string",
                "encryptionType": "ZIXI_AES_128"
              },
              "fecBlockMs": 1,
              "fecOverhead": 1,
              "latencyMode": "ZIXI_LATENCY_STATIC",
              "maxLatency": 1,
              "password": "string",
              "timeout": 1,
              "user": "string"
            }
          },
          "originSettings": {
            "ipNetworkAddress": "string",
            "originOutputEndPoints": [
              {
                "id": "string",
                "originOutputProtocol": "HTTP",
                "packagingProfileType": "string",
                "absoluteBaseURL": "string",
                "alternativeAbsoluteBaseURL": "string",
                "alternativePathwayName": "string",
                "backup": {
                  "enable": true,
                  "hostname": "string",
                  "networkIpAddress": "string",
                  "password": "string",
                  "path": "string",
                  "port": 1,
                  "username": "string"
                },
                "compatibilityMode": "STANDARD",
                "contentSteeringServerURL": "string",
                "drm": {
                  "enable": true,
                  "requestorId": "string",
                  "resourceId": "string",
                  "url": "string"
                },
                "enableAbsoluteURL": true,
                "enableContentSteeringPlaylist": true,
                "fromliveAbsoluteBaseURL": "string",
                "headerAuthName": "string",
                "headerAuthValue": "string",
                "hostname": "string",
                "insertPlaylistCustomTag": true,
                "labels": [
                  "string"
                ],
                "localPathwayName": "string",
                "outputMode": "LIVE_AND_TIMESHIFT",
                "password": "string",
                "path": "string",
                "playlistCustomTag": "string",
                "port": 1,
                "profileName": "string",
                "publishName": "string",
                "redundancyMode": "NONE",
                "streamsPerTcpConnection": "ONE_STREAM",
                "username": "string",
                "variantPlaylistFileName": "string"
              }
            ]
          },
          "psiSiTableSpoolingConfig": [
            {
              "psiSiTables": [
                {
                  "bitrate": 1,
                  "pid": 1,
                  "psiSiContent": "string",
                  "psiSiType": "PAT"
                }
              ]
            }
          ],
          "sdiSettings": {
            "card": 1,
            "gpio": {
              "enable": true,
              "enableRtn": true,
              "preroll": 1
            },
            "muteOutputOnSignalLoss": true,
            "port": 1,
            "sdiUhdSettings": {
              "sdiUhdType": "QUAD_3G",
              "sdiUhdVariant": "ST425_5_2SI"
            },
            "st2110Parameters": {
              "nmosEnabled": true,
              "secondaryOutputEnabled": true,
              "st2110OutComponents": [
                {
                  "primaryMulticast": {
                    "ipAddress": "string",
                    "networkInterface": "string",
                    "port": 1
                  },
                  "secondaryMulticast": {
                    "ipAddress": "string",
                    "networkInterface": "string",
                    "port": 1
                  },
                  "streamType": "ST2110_20",
                  "tid": 1
                }
              ]
            }
          }
        }
      ],
      "type": "IP"
    }
  ],
  "pools": [
    {
      "divitrackIP": "string",
      "divitrackIpNetworkAddress": "string",
      "divitrackPoolBitrate": 1,
      "divitrackPoolId": 1,
      "divitrackPoolLatencyMode": "DEFAULT",
      "divitrackPort": 1,
      "downstreamComplexityIpDelay": 1,
      "downstreamIpDelay": 1,
      "id": "string",
      "labels": [
        "string"
      ],
      "maxSourcesDelay": 1,
      "muxAddress": [
        "string"
      ],
      "name": "string",
      "poolMode": "VBR",
      "stcIp": "string",
      "stcPort": 1,
      "upstreamIpDelay": 1,
      "useNominalBitrate": true
    }
  ],
  "service": {
    "profileId": "string",
    "addons": {
      "affiliateAddon": {
        "affiliateId": "string"
      },
      "broadcasterIdAddon": {
        "origin": "ATSC"
      },
      "captionsAddon": {
        "captionsInfo": [
          {
            "captionsProvider": "e_NCI",
            "tcpPort": 1
          }
        ]
      },
      "casAddon": {
        "casSystems": [
          {
            "accessCriteria": "string",
            "casId": "string",
            "ecmId": "string"
          }
        ],
        "enable": true
      },
      "demuxAddon": {
        "camAddon": {
          "camParameters": [
            {
              "progNums": [
                1
              ],
              "slotId": 1
            }
          ]
        },
        "demuxType": "e_DVB",
        "descramblingKeys": [
          {
            "keyId": "string",
            "programNum": 1
          }
        ],
        "descramblingPrograms": [
          {
            "programNum": 1
          }
        ],
        "highJitter": true
      },
      "drmAddon": {
        "customKeyRotationTime": "2024-01-15T09:30:00Z",
        "enable": true,
        "settings": [
          {
            "drmSystemId": "string",
            "originOutputEndPointId": "string",
            "resourceId": "string",
            "useFixedResource": true
          }
        ]
      },
      "easPropertiesAddon": {
        "enableEas": true,
        "groupId": 1,
        "stationId": "string"
      },
      "inputMonitoringAddon": {
        "enable": true
      },
      "irdetoWatermarkAddon": {
        "directId": 1
      },
      "kantarSnapWatermarkAddon": {
        "audFileId": "string",
        "channelConfigs": [
          {
            "channelName": "string",
            "languageIndex": 1,
            "sourceLabel": "string"
          }
        ],
        "licFileId": "string"
      },
      "liveEventAddon": {
        "autoGenerateAcquisitionPointId": true,
        "confidenceMonitoring": true,
        "endTimeInUtc": "string",
        "recording": true,
        "startTimeInUtc": "string"
      },
      "logoAddon": {
        "imageId": "string",
        "groupMode": true,
        "horizontalOffset": 1,
        "hourlySchedule": [
          {
            "endMinute": 1,
            "endSecond": 1,
            "startMinute": 1,
            "startSecond": 1
          }
        ],
        "logosList": [
          {
            "imageId": "string",
            "horizontalOffset": 1,
            "placement": "BOTTOM_LEFT",
            "uuid": "string",
            "verticalOffset": 1
          }
        ],
        "logosListForGroupMode": [
          {
            "imageId": "string",
            "logoSlateGroupLabel": "string",
            "horizontalOffset": 1,
            "placement": "BOTTOM_LEFT",
            "verticalOffset": 1
          }
        ],
        "placement": "BOTTOM_LEFT",
        "verticalOffset": 1
      },
      "muxAddon": {
        "bandwidth": 1
      },
      "nielsenWatermarkAddon": {
        "nielsenWatermarkConfig": [
          {
            "languageIndex": 1,
            "nielsenWatermarkProperties": {
              "cbetCheckDigits": "string",
              "cbetSid": 1,
              "checkDigits": "string",
              "sid": 1
            },
            "sourceLabel": "string"
          }
        ]
      },
      "operatorActionAddon": {
        "muteOperation": true
      },
      "parentalControlAddon": {
        "callbackServer": {
          "authentication": {
            "enable": true,
            "password": "string",
            "username": "string"
          }
        },
        "callbackUrl": "string",
        "channelId": "string",
        "commandScheduler": {
          "authentication": {
            "enable": true,
            "password": "string",
            "username": "string"
          },
          "endpoint": "string",
          "triggerRepublishOnEmptySchedule": {
            "enable": true,
            "intervalInMinutes": 1
          }
        },
        "hlsID3Pid": 1
      },
      "playoutSettingsAddon": {
        "cleanLayers": [
          {
            "layerId": 1
          }
        ]
      },
      "scheduler360Addon": {
        "channelId": "string"
      },
      "scte35SlateAddon": {
        "enableVideoSlate": true,
        "graphicFilename": "string",
        "imageId": "string",
        "trigger": "e_AUTO",
        "zoneIdentity": "string"
      },
      "slateWatermarkAddon": {
        "image_a_Id": "string",
        "image_b_Id": "string",
        "slateWatermarkType": "e_SLATE_IMAGE"
      },
      "synamediaWatermarkAddon": {
        "channelId": "string",
        "watermarkType": "e_WATERMARKING"
      },
      "thumbnailExporterAddon": {
        "generationInterval": 1,
        "exportPath": "string",
        "height": 1,
        "password": "string",
        "prefix": "string",
        "suffix": "e_TIMESTAMP",
        "userName": "string",
        "width": 1
      },
      "timeAdjustment": {
        "timeAdjInMs": 1
      },
      "timeAdjustmentAddon": {
        "timeAdjInMs": 1
      },
      "timedEventAddon": {
        "callbackServer": {
          "authentication": {
            "enable": true,
            "password": "string",
            "username": "string"
          }
        },
        "callbackUrl": "string",
        "channelId": "string",
        "commandScheduler": {
          "authentication": {
            "enable": true,
            "password": "string",
            "username": "string"
          },
          "endpoint": "string",
          "triggerRepublishOnEmptySchedule": {
            "enable": true,
            "intervalInMinutes": 1
          }
        },
        "hlsParentalControlID3Pid": 1,
        "hlsPeacockEventID3Pid": 1,
        "id3MetadataEventPid": 1,
        "timedEventType": "e_PARENTAL_CONTROL"
      },
      "trafficAddon": {
        "trafficId": 1
      },
      "videoInsertionAddon": {
        "dpiTierSetting": {
          "authorizedDpiTiers": [
            1
          ],
          "blockScte35InputMessages": true
        },
        "esamServiceSetting": {
          "acquisitionPointId": "string",
          "passthroughOnInBandDisabled": true,
          "poisEndpoint": "string",
          "poisNotifyOnlyMode": true,
          "spliceImmediateSpeUtcPointOffset": 1,
          "timecodeReference": true,
          "tlsKeyId": "string",
          "utcTimeOffset": 1
        },
        "gpiTriggers": [
          {
            "delay": 1,
            "edge": "GPI_RISING",
            "name": "string",
            "scte35Message": "string"
          }
        ]
      }
    },
    "availabilityZone": "string",
    "controlState": "ACTIVATED",
    "deploymentInformation": {
      "accountPrefix": "string",
      "deploymentId": "string",
      "deploymentType": "string",
      "deviceName": "string",
      "platformRegionZone": "string"
    },
    "destinationId": "string",
    "destinationsId": [
      "string"
    ],
    "dynamicProgramMode": "ON",
    "extraVideoDelay": 1,
    "geoRedundancyMode": "ON",
    "geoRedundancyTimeReference": "AUTO",
    "id": "string",
    "labels": [
      "string"
    ],
    "name": "string",
    "orchestrationLabels": [
      {
        "key": "string",
        "value": "string"
      }
    ],
    "orchestrationNodeSelectors": [
      {
        "key": "string",
        "value": "string"
      }
    ],
    "pauseGeoRedundancy": true,
    "priority": "LOW",
    "processingParameters": {
      "audioProperties": [
        {
          "aacHeader": "e_ADTS",
          "ac4IframeInterval": 1,
          "bitrate": "e_AUTO_SELECT",
          "channels": "e_PASSTHROUGH",
          "gain": 1,
          "languageIndex": 1,
          "sampleRate": "e_16",
          "sourceLabel": "string",
          "targetlevel": "e_None"
        }
      ],
      "dataProperties": {
        "cc608To708Translation": "e_AUTOSENSE",
        "dvbSubBurnIn": {
          "enableDvbSubtitleBurnIn": true,
          "label": "string"
        },
        "generateTimecode": "e_DISABLED",
        "teletextOverSdiOutput": "e_WST"
      },
      "decoderSettings": {
        "contributionMode": true,
        "latency": {
          "e2eLatency": 1,
          "enableTcPtpLatency": true,
          "jamTime": 1,
          "utcTaiOffset": 1
        },
        "st2110AudioLayout": {
          "audioMapping": [
            1
          ]
        }
      },
      "streamConditioning": "AUTO",
      "videoProperties": {
        "aspectRatio": "e_16_9",
        "goplenM": "e_AUTO",
        "goplenN": 1,
        "gopoption": "e_OPEN_FIXED",
        "irisVQBoost": "e_DISABLED",
        "latencyOption": "e_2_5",
        "resolutionHV": "e_352x480I",
        "stressBias": "e_CLEAN"
      }
    },
    "programNum": 1,
    "redundancyMode": "ON",
    "sdiAudioFormats": [
      "PCM_stereo"
    ],
    "serviceSources": [
      {
        "rank": 1,
        "sourceId": "string",
        "sourceSwitchBufferSize": 1
      }
    ],
    "serviceTrackingMode": "ON",
    "serviceTrackingSetting": {
      "outputFollowInputPid": true,
      "pidOffset": 1
    },
    "serviceType": "LIVE",
    "sourceFailoverConditions": [
      {
        "type": "PID_MISSING"
      }
    ],
    "sourceSwitchSetting": {
      "esamSourceSwitchSetting": {
        "fallbackTimeout": 1,
        "proprietaryScte104VitcMode": true
      },
      "inactiveSourceHandling": "e_AUTO",
      "primaryStableTime": 1,
      "sourceSwitchTrigger": "e_SOURCE_FAILURE",
      "triggerSettings": {
        "ccErrorsThreshold": 1,
        "ccErrorsWindow": 1,
        "customPidMissingList": [
          1
        ],
        "customPidMissingWindow": 1
      }
    },
    "subServices": [
      {
        "profileId": "string",
        "addons": null,
        "destinationsId": [
          "string"
        ],
        "dynamicProgramMode": "ON",
        "id": "string",
        "labels": [
          "string"
        ],
        "programNum": 1
      }
    ]
  }
}

includes pools and destinations

Authentication

AuthorizationBearer

Bearer authentication of the form Bearer <token>, where token is your auth token.

Request

muxService

destinationslist of objectsOptional

poolslist of objectsOptional

serviceobjectOptional

Response

destinationslist of objectsOptional

poolslist of objectsOptional

serviceobjectOptional

Errors

400

Bad Request Error

401

Unauthorized Error

403

Forbidden Error

404

Not Found Error