Skip to navigation
VOS APIConfigure Service

Create service

Create new service to the system.

Authentication

AuthorizationBearer

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

Query parameters

rollingUpgradebooleanOptional
rollingUpgrade

Request

service
profileIdstringRequired
Id of profile used by a service
addonsobjectOptional
availabilityZonestringOptional
Availability zone where the service shall run
controlStateenumOptional
Control state of a service
Allowed values:
deploymentInformationobjectOptional
destinationIdstringOptional
Id of destination connected to a service
destinationsIdlist of stringsOptional
List of destination connected to a service
dynamicProgramModeenumOptional
Specify the dynamic program mode of a service
Allowed values:
extraVideoDelayintegerOptional
This overrides the same param in LabWizard profile
geoRedundancyModeenumOptional
Specify the geographic redundancy mode of a service
Allowed values:
geoRedundancyTimeReferenceenumOptional
Specify the geographic redundancy time reference of a service
Allowed values:
idstringOptional
Unique identifier of a service in UUID format
labelslist of stringsOptional
Labels attached to service for identification
namestringOptional
Display name of a service
orchestrationLabelslist of objectsOptional
Labels for service orchestration
orchestrationNodeSelectorslist of objectsOptional
Labels for service node selector
pauseGeoRedundancybooleanOptional
Declare if Geo redundancy is paused.
priorityenumOptional

Priority of a service (low, normal, high)

Allowed values:
processingParametersobjectOptional
programNumintegerOptional
Program number of a service
redundancyModeenumOptional

Specify the redundancy mode of a service; Service rank will take effect if it's on

Allowed values:
sdiAudioFormatslist of enumsOptional

list of output sdi audio format (maximum 8 audio formats)

Allowed values:
serviceSourceslist of objectsOptional
Sources connected to a service
serviceTrackingModeenumOptional
Specify the service tracking mode of a service
Allowed values:
serviceTrackingSettingobjectOptional
serviceTypeenumOptional
Type of service. Specifies if the SSPE POD should be kept alive after service become OFFLINE
Allowed values:
sourceFailoverConditionslist of objectsOptional
Specify type of SourceFailoverCondition of a service
sourceSwitchSettingobjectOptional
subServiceslist of objectsOptional
Multi Encoding Profiles Sevice

Response

OK

Errors

400
Bad Request Error
401
Unauthorized Error
403
Forbidden Error
404
Not Found Error