Update Cloud Source state

PUT

https://device.example.com/cluster1/vos-api/syndicate/v1/cloudsources/:pipeId/state

PUT

/cluster1/vos-api/syndicate/v1/cloudsources/:pipeId/state

curl -X PUT https://device.example.com/cluster1/vos-api/syndicate/v1/cloudsources/pipeId/state \
     -H "Authorization: Bearer <token>"

{
  "backupCallerModeConfig": {
    "address": "string",
    "clientId": "string",
    "crypto": {
      "key": "string",
      "method": "AES_128"
    },
    "latency": 1,
    "port": 1,
    "sessionId": "string",
    "streamId": "string"
  },
  "backupIngress": {
    "cryptoSetting": {
      "key": "string",
      "method": "AES_128"
    },
    "customUrl": "string",
    "platform": "string",
    "privateUrl": "string",
    "protocol": "string",
    "region": "string",
    "streamCount": 1,
    "url": "string"
  },
  "callerModeConfig": {
    "address": "string",
    "clientId": "string",
    "crypto": {
      "key": "string",
      "method": "AES_128"
    },
    "latency": 1,
    "port": 1,
    "sessionId": "string",
    "streamId": "string"
  },
  "connectionMode": "LISTENER",
  "customDnsName": "string",
  "groomingEndpoint": {
    "cryptoSetting": {
      "key": "string",
      "method": "AES_128"
    },
    "customUrl": "string",
    "privateUrl": "string",
    "url": "string"
  },
  "ingress": {
    "cryptoSetting": {
      "key": "string",
      "method": "AES_128"
    },
    "customUrl": "string",
    "platform": "string",
    "privateUrl": "string",
    "protocol": "string",
    "region": "string",
    "streamCount": 1,
    "url": "string"
  },
  "labels": [
    "string"
  ],
  "maxOutputConnections": 1,
  "name": "string",
  "pendingRestart": true,
  "pipeId": "string",
  "profileId": "string",
  "publicIpMode": "IPV4_ONLY",
  "redundancyMode": "string",
  "resourceMode": "DEDICATED",
  "state": "string",
  "statistics": {
    "backupSelected": true,
    "egressStatistics": {
      "egressSessionCount": 1,
      "egressThroughputInMbps": 1.1
    },
    "ingressStatistics": {
      "bitrate": 1.1,
      "packetLost": 1,
      "packetReceived": 1
    }
  },
  "streamConfig": [
    {
      "egressConnectionLimit": "string",
      "streamId": "string"
    }
  ],
  "version": "string"
}

Authentication

AuthorizationBearer

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

Path parameters

pipeIdstringRequired

pipeId

Query parameters

stateenumOptional

state

Allowed values:

Response

backupCallerModeConfigobjectOptional

backupIngressobjectOptional

callerModeConfigobjectOptional

connectionModeenumOptional

Allowed values:

customDnsNamestringOptional

groomingEndpointobjectOptional

ingressobjectOptional

labelslist of stringsOptional

maxOutputConnectionsintegerOptional

namestringOptional

pendingRestartbooleanOptional

pipeIdstringOptional

profileIdstringOptional

publicIpModeenumOptional

Allowed values:

redundancyModestringOptional

resourceModeenumOptional

Allowed values:

statestringOptional

statisticsobjectOptional

streamConfiglist of objectsOptional

versionstringOptional

Errors

400

Bad Request Error

401

Unauthorized Error

403

Forbidden Error

404

Not Found Error

422

Unprocessable Entity Error

424

Failed Dependency Error