Get source

GET

https://device.example.com/cluster1/vos-api/configure/v1/sources/:id

GET

/cluster1/vos-api/configure/v1/sources/:id

curl https://device.example.com/cluster1/vos-api/configure/v1/sources/id \
     -H "Authorization: Bearer <token>"

{
  "cspCoreProperties": {
    "insertionPeriodMs": 1,
    "segmentationEventId": 1,
    "segmentationUpid": "string",
    "segmentationUpidType": 1
  },
  "id": "string",
  "inputRedundancyMode": "PRIMARY_ONLY",
  "inputs": [
    {
      "asiSettings": {
        "asiCard": 1,
        "asiPort": 1,
        "automaticGrooming": true,
        "grooming": {
          "bitrate": 1,
          "pcrCompliant": true,
          "pmtPid": 1,
          "programName": "string"
        },
        "pcrConstraints": {
          "maxPcrInterval": 100,
          "maxPcrJitter": 50
        },
        "programNum": 1,
        "sporadicVideoFrames": true,
        "tsProgramNumber": 1
      },
      "cloudInputSettings": {
        "automaticGrooming": true,
        "backupPipeId": "string",
        "cloudInputType": "CLOUD_SOURCE",
        "cloudResourceMode": "SHARED",
        "egressPointId": "string",
        "egressPointObjectId": "string",
        "grooming": {
          "bitrate": 1,
          "pcrCompliant": true,
          "pmtPid": 1,
          "programName": "string"
        },
        "name": "string",
        "pcrConstraints": {
          "maxPcrInterval": 100,
          "maxPcrJitter": 50
        },
        "pipeId": "string",
        "programNum": 1,
        "protocol": "string",
        "region": "string",
        "regionDisplayName": "string",
        "sporadicVideoFrames": true,
        "srtCloudInputSettings": {
          "connectionMode": "LISTENER",
          "encryptionParam": {
            "encryptionKey": "string",
            "encryptionType": "AES_128"
          },
          "latency": 1,
          "srtConnectionInfo": {
            "lowerLatencyLimit": 1,
            "rtt": 1,
            "upperLatencyLimit": 1
          },
          "srtConnectionSettingsList": [
            {
              "ipAddress": "string",
              "ipNetworkAddress": "string",
              "latency": 1,
              "port": 1,
              "srtEncryptionParams": {
                "encryptionKey": "string",
                "encryptionType": "AES_128"
              },
              "streamId": "string",
              "streamIndex": 1
            }
          ]
        },
        "userStreamId": "string"
      },
      "cloudSourceSetting": {
        "automaticGrooming": true,
        "backupPipeId": "string",
        "connectionMode": "LISTENER",
        "grooming": {
          "bitrate": 1,
          "pcrCompliant": true,
          "pmtPid": 1,
          "programName": "string"
        },
        "name": "string",
        "pcrConstraints": {
          "maxPcrInterval": 100,
          "maxPcrJitter": 50
        },
        "pipeId": "string",
        "programNum": 1,
        "protocol": "string",
        "region": "string",
        "sporadicVideoFrames": true,
        "srtCloudSourceSettings": {
          "latency": 1
        }
      },
      "cloudlinkSetting": {
        "ipAddress": "string",
        "ipPort": 1,
        "ipPortRangeEnd": 1,
        "ssmIpAddresses": [
          "string"
        ],
        "type": "ZIXI",
        "uplinkGroupId": "string",
        "uplinkId": "string"
      },
      "delayLineSettings": {
        "delay": 1,
        "recordId": "string",
        "delayUpdate": true,
        "nextDelay": 1,
        "nextDelayActivationDate": "string"
      },
      "demuxSettings": {
        "demuxServiceId": "string",
        "automaticGrooming": true,
        "disableAutoDelete": true,
        "grooming": {
          "bitrate": 1,
          "pcrCompliant": true,
          "pmtPid": 1,
          "programName": "string"
        },
        "pcrConstraints": {
          "maxPcrInterval": 100,
          "maxPcrJitter": 50
        },
        "programNum": 1,
        "sporadicVideoFrames": true
      },
      "id": "string",
      "ipSettings": {
        "ipAddress": "string",
        "ipPort": 1,
        "automaticGrooming": true,
        "descramblingKey": "string",
        "fecEnable": true,
        "grooming": {
          "bitrate": 1,
          "pcrCompliant": true,
          "pmtPid": 1,
          "programName": "string"
        },
        "ipNetworkAddress": "string",
        "ipPortRangeEnd": 1,
        "pcrConstraints": {
          "maxPcrInterval": 100,
          "maxPcrJitter": 50
        },
        "programNum": 1,
        "smpte20227TsInput": {
          "ipAddress": "string",
          "ipPort": 1,
          "pathDifferentialDelayMs": 1,
          "ipNetworkAddress": "string",
          "ssmIpAddresses": [
            "string"
          ]
        },
        "sporadicVideoFrames": true,
        "ssmIpAddresses": [
          "string"
        ],
        "tsProgramNumber": 1
      },
      "ipSettingsList": [
        {
          "ipAddress": "string",
          "ipPort": 1,
          "automaticGrooming": true,
          "descramblingKey": "string",
          "fecEnable": true,
          "grooming": {
            "bitrate": 1,
            "pcrCompliant": true,
            "pmtPid": 1,
            "programName": "string"
          },
          "ipNetworkAddress": "string",
          "ipPortRangeEnd": 1,
          "pcrConstraints": {
            "maxPcrInterval": 100,
            "maxPcrJitter": 50
          },
          "programNum": 1,
          "smpte20227TsInput": {
            "ipAddress": "string",
            "ipPort": 1,
            "pathDifferentialDelayMs": 1,
            "ipNetworkAddress": "string",
            "ssmIpAddresses": [
              "string"
            ]
          },
          "sporadicVideoFrames": true,
          "ssmIpAddresses": [
            "string"
          ],
          "tsProgramNumber": 1
        }
      ],
      "labels": [
        "string"
      ],
      "multiviewSettings": {
        "frameRate": {
          "denominator": 1,
          "numerator": 1
        },
        "resolution": {
          "height": 1,
          "width": 1
        },
        "sources": [
          {
            "closedCaptions": "e_DISABLE",
            "regionDest": {
              "height": 1,
              "topLeftCornerX": 1,
              "topLeftCornerY": 1,
              "width": 1
            },
            "sourceId": "string"
          }
        ],
        "backgroundImage": "string",
        "delay": 1
      },
      "ottPlayoutSettings": {
        "defaultAssetUrl": "string"
      },
      "poolSettings": {
        "poolId": "string"
      },
      "rank": 1,
      "rfSettingsV2": {
        "tuner": 1,
        "type": "DVB_S2X",
        "atscTuner": {
          "channel": 1,
          "standard": "ATSC_1_0"
        },
        "card": 1,
        "dvbS2XPort": {
          "lnbType": "C_BAND",
          "oscillatorFrequency": 1.1,
          "frequencySpectrum": "LOW_BAND"
        },
        "dvbS2XTuner": {
          "carrierFrequency": 1.1,
          "plsCode": 1,
          "polarization": "HORIZONTAL",
          "symbolRate": 1.1,
          "inversion": "AUTO",
          "modulationAndFec": "QPSK_1_2",
          "pilots": "AUTO",
          "rollOff": "AUTO"
        },
        "tsProgramNumber": 1
      },
      "slateSettings": {
        "type": "SIGNAL_LOSS",
        "enableVideoSlate": true,
        "graphicFilename": "string",
        "imageId": "string",
        "signalLossSlateSettings": {
          "insertionSettings": true,
          "insertionThreshold": 1,
          "resetThreshold": 1,
          "revertThreshold": 1
        }
      },
      "srtSettings": {
        "automaticGrooming": true,
        "cloudlinkGroupId": "string",
        "connectionMode": "LISTENER",
        "descramblingKey": "string",
        "descramblingRequired": true,
        "grooming": {
          "bitrate": 1,
          "pcrCompliant": true,
          "pmtPid": 1,
          "programName": "string"
        },
        "ipNetworkAddress": "string",
        "latency": 1,
        "pathRedundancyMode": "SRT_SOCKET_GROUP",
        "pcrConstraints": {
          "maxPcrInterval": 100,
          "maxPcrJitter": 50
        },
        "programNum": 1,
        "seamlessInputSwitching": true,
        "sourceAddr": "string",
        "sourcePort": 1,
        "sourcePortRangeEnd": 1,
        "sporadicVideoFrames": true,
        "srtConnectionSettings": [
          {
            "ipAddress": "string",
            "ipNetworkAddress": "string",
            "latency": 1,
            "port": 1,
            "srtEncryptionParams": {
              "encryptionKey": "string",
              "encryptionType": "AES_128"
            },
            "streamId": "string",
            "streamIndex": 1
          }
        ],
        "ssmIpAddrs": [
          "string"
        ],
        "st20227DelayBufferInMs": 1,
        "tsProgramNumber": 1
      },
      "type": "IP",
      "zixiSettings": {
        "automaticGrooming": true,
        "encoderSetting": {
          "decryptionKey": "string",
          "decryptionType": "NONE",
          "zixiEndPointSetting": {
            "zixiEndpointId": "string"
          }
        },
        "grooming": {
          "bitrate": 1,
          "pcrCompliant": true,
          "pmtPid": 1,
          "programName": "string"
        },
        "harmonicUplinkSetting": {
          "ipAddress": "string",
          "descramblingKey": "string",
          "descramblingRequired": true,
          "ipPort": 1,
          "ipPortRangeEnd": 1,
          "ssmIpAddresses": [
            "string"
          ],
          "uplinkGroupId": "string",
          "uplinkId": "string"
        },
        "harmonicUplinkSettingList": [
          {
            "ipAddress": "string",
            "descramblingKey": "string",
            "descramblingRequired": true,
            "ipPort": 1,
            "ipPortRangeEnd": 1,
            "ssmIpAddresses": [
              "string"
            ],
            "uplinkGroupId": "string",
            "uplinkId": "string"
          }
        ],
        "pcrConstraints": {
          "maxPcrInterval": 100,
          "maxPcrJitter": 50
        },
        "programNum": 1,
        "sporadicVideoFrames": true,
        "zixiBroadcasterSetting": null,
        "zixiInputType": "HARMONIC_UPLINK"
      }
    }
  ],
  "labels": [
    "string"
  ],
  "name": "string",
  "pmtPid": "string"
}

Get source by {id}.

Authentication

AuthorizationBearer

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

Path parameters

idstringRequired

Response

cspCorePropertiesobjectOptional

idstringOptional

Unique identifier of a source in UUID format

inputRedundancyModeenumOptional

Allowed values:

inputslist of objectsOptional

An input is a singular network location from which to receive content

labelslist of stringsOptional

Labels attached to source for identification

namestringOptional

Display name of a source

pmtPidstringOptional

(Deprecated) PMT PID number of selected program

Errors

401

Unauthorized Error

403

Forbidden Error

404

Not Found Error

500

Internal Server Error