Scan stream information

POST

https://device.example.com/cluster1/vos-api/source-monitor/v1/discover

POST

/cluster1/vos-api/source-monitor/v1/discover

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

{
  "sourceType": "IP",
  "cloudSource": {
    "automaticGrooming": true,
    "cloudInputType": "CLOUD_SOURCE",
    "cloudSourceType": "SRT",
    "egressId": "string",
    "region": "string",
    "resourceMode": "SHARED",
    "sourceId": "string",
    "srtSource": {
      "automaticGrooming": true,
      "cloudlinkGroupId": "string",
      "cloudlinkId": "string",
      "connectionMode": "LISTENER",
      "descramblingKey": "string",
      "descramblingRequired": true,
      "ipAddress": "string",
      "ipNetworkAddress": "string",
      "ipPort": 1,
      "ipPortRangeEnd": 1,
      "latency": 1,
      "pathRedundancyMode": "SRT_SOCKET_GROUP",
      "pidList": [
        1
      ],
      "programId": 1,
      "srtConnectionSettings": [
        {
          "ipAddress": "string",
          "ipNetworkAddress": "string",
          "latency": 1,
          "port": 1,
          "srtEncryptionParams": {
            "encryptionKey": "string",
            "encryptionType": "AES_128"
          },
          "streamId": "string"
        }
      ],
      "srtEncryptionParams": {
        "encryptionKey": "string",
        "encryptionType": "AES_128"
      },
      "ssmIpAddresses": [
        "string"
      ],
      "st20227DelayBufferInMs": 1,
      "streamIds": [
        "string"
      ]
    },
    "userStreamId": "string"
  },
  "creationTimestamp": 1,
  "demuxSource": {
    "demuxServiceId": "string"
  },
  "hspSource": {
    "hspEndpoint": "string",
    "variantPlaylistFileName": "string",
    "authenticationHeader": {
      "isDirty": true,
      "key": "string",
      "value": "string"
    },
    "backupEndpointSettings": {
      "hspEndpoint": "string",
      "variantPlaylistFileName": "string",
      "authenticationHeader": {
        "isDirty": true,
        "key": "string",
        "value": "string"
      },
      "ipNetworkAddress": "string"
    },
    "ipNetworkAddress": "string",
    "scte35Annotation": "NONE"
  },
  "id": "string",
  "inputId": "string",
  "ipSourceRange": {
    "ipPortRangeEnd": 1,
    "ipPortRangeStart": 1,
    "ipRangeEnd": "string",
    "ipRangeStart": "string",
    "descramblingKey": "string",
    "ipNetworkAddress": "string",
    "smpte20227DelayBufferInMs": 1,
    "smpte20227IpSource": {
      "ip": "string",
      "ipPort": 1,
      "ipNetworkAddress": "string",
      "ssm": [
        "string"
      ]
    },
    "ssm": [
      "string"
    ]
  },
  "probingDurationInMs": 1,
  "rfsource": {
    "adapter": 1,
    "frontend": 1,
    "rfdeliverySystemType": "DVBT"
  },
  "sourceId": "string",
  "srtSource": {
    "automaticGrooming": true,
    "cloudlinkGroupId": "string",
    "cloudlinkId": "string",
    "connectionMode": "LISTENER",
    "descramblingKey": "string",
    "descramblingRequired": true,
    "ipAddress": "string",
    "ipNetworkAddress": "string",
    "ipPort": 1,
    "ipPortRangeEnd": 1,
    "latency": 1,
    "pathRedundancyMode": "SRT_SOCKET_GROUP",
    "pidList": [
      1
    ],
    "programId": 1,
    "srtConnectionSettings": [
      {
        "ipAddress": "string",
        "ipNetworkAddress": "string",
        "latency": 1,
        "port": 1,
        "srtEncryptionParams": {
          "encryptionKey": "string",
          "encryptionType": "AES_128"
        },
        "streamId": "string"
      }
    ],
    "srtEncryptionParams": {
      "encryptionKey": "string",
      "encryptionType": "AES_128"
    },
    "ssmIpAddresses": [
      "string"
    ],
    "st20227DelayBufferInMs": 1,
    "streamIds": [
      "string"
    ]
  },
  "zixiSource": {
    "harmonicUplinkSetting": {
      "descramblingKey": "string",
      "descramblingRequired": true,
      "ipAddress": "string",
      "ipPort": 1,
      "ipPortRangeEnd": 1,
      "pidList": [
        1
      ],
      "programId": 1,
      "ssmIpAddresses": [
        "string"
      ],
      "uplinkGroupId": "string",
      "uplinkId": "string"
    }
  }
}

Scan stream information.

Authentication

AuthorizationBearer

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

Request

discoverySource

sourceTypeenumRequired

Source Type

cloudSourceobjectOptional

creationTimestamplongOptional

Creation timestamp of Discovery Task

demuxSourceobjectOptional

hspSourceobjectOptional

idstringOptional

Discovery ID

inputIdstringOptional

Input ID

ipSourceRangeobjectOptional

probingDurationInMsintegerOptional

Probing duration in milliseconds. Ranging from 5000 to 30000 ms. Default value is 5000 ms

rfsourceobjectOptional

sourceIdstringOptional

Source ID

srtSourceobjectOptional

zixiSourceobjectOptional

Response

sourceTypeenum