Skip to navigation
VOS APIConfigure Pool

Get pools

List divitrack pools in the system.

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

Response

Success
divitrackIPstringOptional
IP address for the divitrack rate message
divitrackIpNetworkAddressstringOptional
Interface address for sending and receiving divitrack messages
divitrackPoolBitrateintegerOptional
Bitrate for the divitrack pool in bps
divitrackPoolIdintegerOptional
Divitrack pool id
divitrackPoolLatencyModeenumOptional
Latency mode for a divitrack pool
Allowed values:
divitrackPortintegerOptional
Port for the divitrack rate message
downstreamComplexityIpDelayintegerOptional
Network delay for the downstream complexity message
downstreamIpDelayintegerOptional
Downstream network delay
idstringOptional

Unique identifier of a pool. If specified, pool source will not be created automatically (not applicable for /mux/v1/services API).

labelslist of stringsOptional
Labels attached to a pool for identification
maxSourcesDelayintegerOptional
Maximum sources delay
muxAddresslist of stringsOptional
IP addresses of the mux
namestringOptional
Display name of a pool
poolModeenumOptional
Rate mode for the pool
Allowed values:
stcIpstringOptional
IP address for the divitrack STC message
stcPortintegerOptional
Port for the divitrack STC message
upstreamIpDelayintegerOptional
Upstream network delay
useNominalBitratebooleanOptional

Use the provisioned nominal bitrate by user in destination object. If this value is false or absent, nominal bitrate will be determined automatically. (For internal use)

Errors

401
Unauthorized Error
403
Forbidden Error
404
Not Found Error