Get destinations

GET

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

GET

/cluster1/vos-api/configure/v1/destinations

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

[
  {
    "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"
  }
]

List destinations in the system. Destination is configuration resource for a collection of outputs with ranking.

Authentication

AuthorizationBearer

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

Query parameters

namestringOptional

Filter by name

labelstringOptional

Filter by label

skipintegerOptional

Skip N records

topintegerOptional

Top first M records

inUsebooleanOptional

Filter by inUse flag

Response

Success

destinationProfileIdstringOptional

Unique identifier of destination profile associated to this destination. It is required in multiscreen output

idstringOptional

Unique identifier of a destination in UUID format

inUsebooleanOptional

Every destination has a flag inUse when destination is used in service

labelslist of stringsOptional

Labels attached to destination for identification

modifiableByAffiliatebooleanOptional

Flag to indicate whether affiliate can modify this destination. Applicable for XOS IRD

namestringOptional

Display name of a destination

outputslist of objectsOptional

An output is a singular network location for the content processed and output by a service

typeenumOptional

Destination type

Errors

401

Unauthorized Error

403

Forbidden Error

404

Not Found Error