logo
API docs by Redocly

Configuration

Download OpenAPI specification:Download

URL: https://veset.tv/ Terms of Service

Services

Ingest - Library - Channel - Schedule - Playout - Audit - Accounts - Reporting - Monitoring - Configuration - Metrics

Service provider resource

Service provider resource

Get SP configuration

Returns SP configuration

path Parameters
providerId
required
string

Responses

Response samples

Content type
application/json
[
  • {
    }
]

Create sp cloud configuration

Returns sp cloud configuration

path Parameters
providerId
required
string
Request Body schema: application/json
required
accessKey
string
additionalRegions
Array of strings unique
apiKey
string
apiUrl
string
dateCreated
string <date-time>
dateUpdated
string <date-time>
domainKey
string
id
string
object (IngestInstanceConfigurationDTO)
object (MediaStoreSettingsDTO)
organizationId
string
object (PlayoutInstanceSettingsDTO)
providerId
string
region
string
secretKey
string
serviceProviderId
string
type
string
Enum: "AWS" "TELIA" "ALIBABA" "WASABI" "AZURE" "AWS_PAIRED"
Array of objects (VirtualMachineConfigurationDTO)

Responses

Request samples

Content type
application/json
{
  • "accessKey": "string",
  • "additionalRegions": [
    ],
  • "apiKey": "string",
  • "apiUrl": "string",
  • "dateCreated": "2019-08-24T14:15:22Z",
  • "dateUpdated": "2019-08-24T14:15:22Z",
  • "domainKey": "string",
  • "id": "string",
  • "ingestInstanceConfiguration": {
    },
  • "mediaStoreSettings": {
    },
  • "organizationId": "string",
  • "playoutInstanceConfiguration": {
    },
  • "providerId": "string",
  • "region": "string",
  • "secretKey": "string",
  • "serviceProviderId": "string",
  • "type": "AWS",
  • "vmConfigs": [
    ]
}

Response samples

Content type
application/json
{ }

Update service provider cloud config

Returns updated cloud config

path Parameters
providerId
required
string
query Parameters
type
string
Default: "AWS"
Enum: "AWS" "TELIA" "ALIBABA" "WASABI" "AZURE" "AWS_PAIRED"
Request Body schema: application/json
required
accessKey
string
additionalRegions
Array of strings unique
apiKey
string
apiUrl
string
dateCreated
string <date-time>
dateUpdated
string <date-time>
domainKey
string
id
string
object (IngestInstanceConfigurationDTO)
object (MediaStoreSettingsDTO)
organizationId
string
object (PlayoutInstanceSettingsDTO)
providerId
string
region
string
secretKey
string
serviceProviderId
string
type
string
Enum: "AWS" "TELIA" "ALIBABA" "WASABI" "AZURE" "AWS_PAIRED"
Array of objects (VirtualMachineConfigurationDTO)

Responses

Request samples

Content type
application/json
{
  • "accessKey": "string",
  • "additionalRegions": [
    ],
  • "apiKey": "string",
  • "apiUrl": "string",
  • "dateCreated": "2019-08-24T14:15:22Z",
  • "dateUpdated": "2019-08-24T14:15:22Z",
  • "domainKey": "string",
  • "id": "string",
  • "ingestInstanceConfiguration": {
    },
  • "mediaStoreSettings": {
    },
  • "organizationId": "string",
  • "playoutInstanceConfiguration": {
    },
  • "providerId": "string",
  • "region": "string",
  • "secretKey": "string",
  • "serviceProviderId": "string",
  • "type": "AWS",
  • "vmConfigs": [
    ]
}

Response samples

Content type
application/json
{
  • "accessKey": "string",
  • "additionalRegions": [
    ],
  • "apiKey": "string",
  • "apiUrl": "string",
  • "dateCreated": "2019-08-24T14:15:22Z",
  • "dateUpdated": "2019-08-24T14:15:22Z",
  • "domainKey": "string",
  • "id": "string",
  • "ingestInstanceConfiguration": {
    },
  • "mediaStoreSettings": {
    },
  • "organizationId": "string",
  • "playoutInstanceConfiguration": {
    },
  • "providerId": "string",
  • "region": "string",
  • "secretKey": "string",
  • "serviceProviderId": "string",
  • "type": "AWS",
  • "vmConfigs": [
    ]
}

Get SP configuration

Returns SP configuration

path Parameters
providerId
required
string
type
required
string
Enum: "AWS" "TELIA" "ALIBABA" "WASABI" "AZURE" "AWS_PAIRED"

Responses

Response samples

Content type
application/json
{
  • "accessKey": "string",
  • "additionalRegions": [
    ],
  • "apiKey": "string",
  • "apiUrl": "string",
  • "dateCreated": "2019-08-24T14:15:22Z",
  • "dateUpdated": "2019-08-24T14:15:22Z",
  • "domainKey": "string",
  • "id": "string",
  • "ingestInstanceConfiguration": {
    },
  • "mediaStoreSettings": {
    },
  • "organizationId": "string",
  • "playoutInstanceConfiguration": {
    },
  • "providerId": "string",
  • "region": "string",
  • "secretKey": "string",
  • "serviceProviderId": "string",
  • "type": "AWS",
  • "vmConfigs": [
    ]
}

Update service provider cloud config

Returns updated cloud config

path Parameters
providerId
required
string
type
required
string
Enum: "AWS" "TELIA" "ALIBABA" "WASABI" "AZURE" "AWS_PAIRED"
Request Body schema: application/json
required
string

Responses

Request samples

Content type
application/json
"string"

Response samples

Content type
application/json
{
  • "accessKey": "string",
  • "additionalRegions": [
    ],
  • "apiKey": "string",
  • "apiUrl": "string",
  • "dateCreated": "2019-08-24T14:15:22Z",
  • "dateUpdated": "2019-08-24T14:15:22Z",
  • "domainKey": "string",
  • "id": "string",
  • "ingestInstanceConfiguration": {
    },
  • "mediaStoreSettings": {
    },
  • "organizationId": "string",
  • "playoutInstanceConfiguration": {
    },
  • "providerId": "string",
  • "region": "string",
  • "secretKey": "string",
  • "serviceProviderId": "string",
  • "type": "AWS",
  • "vmConfigs": [
    ]
}

Removes existing region for provider cloud configuration and cleanups cloud resources

Returns Org cloudconfiguration

path Parameters
providerId
required
string
type
required
string
Enum: "AWS" "TELIA" "ALIBABA" "WASABI" "AZURE" "AWS_PAIRED"
region
required
string

Responses

Response samples

Content type
application/json
{
  • "accessKey": "string",
  • "additionalRegions": [
    ],
  • "apiKey": "string",
  • "apiUrl": "string",
  • "dateCreated": "2019-08-24T14:15:22Z",
  • "dateUpdated": "2019-08-24T14:15:22Z",
  • "domainKey": "string",
  • "id": "string",
  • "ingestInstanceConfiguration": {
    },
  • "mediaStoreSettings": {
    },
  • "organizationId": "string",
  • "playoutInstanceConfiguration": {
    },
  • "providerId": "string",
  • "region": "string",
  • "secretKey": "string",
  • "serviceProviderId": "string",
  • "type": "AWS",
  • "vmConfigs": [
    ]
}

Initialize new region for organization cloud configuration

Returns Org cloudconfiguration

path Parameters
providerId
required
string
type
required
string
Enum: "AWS" "TELIA" "ALIBABA" "WASABI" "AZURE" "AWS_PAIRED"
region
required
string

Responses

Response samples

Content type
application/json
{
  • "accessKey": "string",
  • "additionalRegions": [
    ],
  • "apiKey": "string",
  • "apiUrl": "string",
  • "dateCreated": "2019-08-24T14:15:22Z",
  • "dateUpdated": "2019-08-24T14:15:22Z",
  • "domainKey": "string",
  • "id": "string",
  • "ingestInstanceConfiguration": {
    },
  • "mediaStoreSettings": {
    },
  • "organizationId": "string",
  • "playoutInstanceConfiguration": {
    },
  • "providerId": "string",
  • "region": "string",
  • "secretKey": "string",
  • "serviceProviderId": "string",
  • "type": "AWS",
  • "vmConfigs": [
    ]
}

Refreshes existing region for provider cloud configuration

Returns Org cloudconfiguration

path Parameters
providerId
required
string
type
required
string
Enum: "AWS" "TELIA" "ALIBABA" "WASABI" "AZURE" "AWS_PAIRED"
region
required
string

Responses

Response samples

Content type
application/json
{
  • "accessKey": "string",
  • "additionalRegions": [
    ],
  • "apiKey": "string",
  • "apiUrl": "string",
  • "dateCreated": "2019-08-24T14:15:22Z",
  • "dateUpdated": "2019-08-24T14:15:22Z",
  • "domainKey": "string",
  • "id": "string",
  • "ingestInstanceConfiguration": {
    },
  • "mediaStoreSettings": {
    },
  • "organizationId": "string",
  • "playoutInstanceConfiguration": {
    },
  • "providerId": "string",
  • "region": "string",
  • "secretKey": "string",
  • "serviceProviderId": "string",
  • "type": "AWS",
  • "vmConfigs": [
    ]
}

HLS Steering resource

HLS steering api

Creates HLS steering configuration

Creates steering configuration

query Parameters
organization
string
providerId
string
Request Body schema: application/json
required
object (HlsDistributionConfiguration)

Distribution configuration of the HLS steering configuration

enabled
boolean

Whether the HLS steering configuration is enabled

id
string
name
string

Name of the HLS steering configuration

organizationId
string

Organization ID of the HLS steering configuration

serviceProviderId
string
Array of objects (HlsSource)

Sources of the HLS steering configuration

Responses

Request samples

Content type
application/json
{
  • "dateCreated": 18277373633,
  • "dateUpdated": 18277373633,
  • "distributionConfiguration": {
    },
  • "enabled": true,
  • "id": "string",
  • "name": "string",
  • "organizationId": "string",
  • "sources": [
    ]
}

Response samples

Content type
application/json
{
  • "dateCreated": 18277373633,
  • "dateUpdated": 18277373633,
  • "distributionConfiguration": {
    },
  • "enabled": true,
  • "id": "string",
  • "name": "string",
  • "organizationId": "string",
  • "sources": [
    ]
}

Deletes HLS steering configuration

Deletes steering configuration

path Parameters
id
required
string
query Parameters
organization
string
providerId
string

Responses

Response samples

Content type
application/json
{
  • "code": 0,
  • "messages": [
    ]
}

Gets HLS steering configuration

Gets steering configuration

path Parameters
id
required
string
query Parameters
organization
string
providerId
string

Responses

Response samples

Content type
application/json
{
  • "dateCreated": 18277373633,
  • "dateUpdated": 18277373633,
  • "distributionConfiguration": {
    },
  • "enabled": true,
  • "id": "string",
  • "name": "string",
  • "organizationId": "string",
  • "sources": [
    ]
}

Updates HLS steering configuration

Updates steering configuration

path Parameters
id
required
string
query Parameters
organization
string
providerId
string
Request Body schema: application/json
required
object (HlsDistributionConfiguration)

Distribution configuration of the HLS steering configuration

enabled
boolean

Whether the HLS steering configuration is enabled

id
string
name
string

Name of the HLS steering configuration

organizationId
string

Organization ID of the HLS steering configuration

serviceProviderId
string
Array of objects (HlsSource)

Sources of the HLS steering configuration

Responses

Request samples

Content type
application/json
{
  • "dateCreated": 18277373633,
  • "dateUpdated": 18277373633,
  • "distributionConfiguration": {
    },
  • "enabled": true,
  • "id": "string",
  • "name": "string",
  • "organizationId": "string",
  • "sources": [
    ]
}

Response samples

Content type
application/json
{
  • "dateCreated": 18277373633,
  • "dateUpdated": 18277373633,
  • "distributionConfiguration": {
    },
  • "enabled": true,
  • "id": "string",
  • "name": "string",
  • "organizationId": "string",
  • "sources": [
    ]
}

Gets HLS steering configurations

Gets steering configurations

query Parameters
organization
string
providerId
string

Responses

Response samples

Content type
application/json
[
  • {
    }
]

Gets HLS master manifest from HLS Steering configuration by token, authentication not required

Gets hls manifest via secret token

path Parameters
token
required
string

Responses

Response samples

Content type
application/json
{
  • "code": 0,
  • "messages": [
    ]
}

User resource

User resource

Create new internal cloud configuration

Returns user configuration

path Parameters
type
required
string
Enum: "AWS" "TELIA" "ALIBABA" "WASABI" "AZURE" "AWS_PAIRED"
Request Body schema: application/json
required
accessKey
string
additionalRegions
Array of strings unique
apiKey
string
apiUrl
string
dateCreated
string <date-time>
dateUpdated
string <date-time>
domainKey
string
id
string
object (IngestInstanceConfigurationDTO)
object (MediaStoreSettingsDTO)
organizationId
string
object (PlayoutInstanceSettingsDTO)
providerId
string
region
string
secretKey
string
serviceProviderId
string
type
string
Enum: "AWS" "TELIA" "ALIBABA" "WASABI" "AZURE" "AWS_PAIRED"
Array of objects (VirtualMachineConfigurationDTO)

Responses

Request samples

Content type
application/json
{
  • "accessKey": "string",
  • "additionalRegions": [
    ],
  • "apiKey": "string",
  • "apiUrl": "string",
  • "dateCreated": "2019-08-24T14:15:22Z",
  • "dateUpdated": "2019-08-24T14:15:22Z",
  • "domainKey": "string",
  • "id": "string",
  • "ingestInstanceConfiguration": {
    },
  • "mediaStoreSettings": {
    },
  • "organizationId": "string",
  • "playoutInstanceConfiguration": {
    },
  • "providerId": "string",
  • "region": "string",
  • "secretKey": "string",
  • "serviceProviderId": "string",
  • "type": "AWS",
  • "vmConfigs": [
    ]
}

Response samples

Content type
application/json
{
  • "accessKey": "string",
  • "additionalRegions": [
    ],
  • "apiKey": "string",
  • "apiUrl": "string",
  • "domainKey": "string",
  • "id": "string",
  • "ingestInstanceConfiguration": {
    },
  • "mediaStoreSettings": {
    },
  • "organizationId": "string",
  • "playoutInstanceConfiguration": {
    },
  • "providerId": "string",
  • "region": "string",
  • "secretKey": "string",
  • "type": "AWS",
  • "vmConfigs": [
    ]
}

Refresh internal cloud configuration

Refreshes internal cloud configuration

path Parameters
type
required
string
Enum: "AWS" "TELIA" "ALIBABA" "WASABI" "AZURE" "AWS_PAIRED"

Responses

Response samples

Content type
application/json
{
  • "code": 0,
  • "messages": [
    ]
}

Get stun servers

Returns stun servers

Responses

Response samples

Content type
application/json
[
  • {
    }
]

Add stun server config

Returns stun server

Request Body schema: application/json
required
continent
required
string
Enum: "AFRICA" "MIDDLE_EAST" "ASIA_PACIFIC" "EUROPE" "NORTH_AMERICA" "SOUTH_AMERICA"
dateCreated
string <date-time>
dateUpdated
string <date-time>
host
required
string
id
string
organizationId
string
port
integer <int32>
region
required
string
serviceProviderId
string
stunServer
string

Responses

Request samples

Content type
application/json
{
  • "continent": "EUROPE",
  • "host": "stun.example.com",
  • "id": "5f9b1b4b7f7b7b0001b3b1b4",
  • "port": 3478,
  • "region": "eu-west-1"
}

Response samples

Content type
application/json
{
  • "continent": "EUROPE",
  • "host": "stun.example.com",
  • "id": "5f9b1b4b7f7b7b0001b3b1b4",
  • "port": 3478,
  • "region": "eu-west-1"
}

Remove stun server config

Removes stun server

path Parameters
id
required
string

Responses

Response samples

Content type
application/json
{
  • "code": 0,
  • "messages": [
    ]
}

Debug clone organization playout

Returns job

path Parameters
organizationId
required
string
playoutId
required
string

Responses

Response samples

Content type
application/json
{
  • "dateCreated": "2019-08-24T14:15:22Z",
  • "dateFinished": "2019-08-24T14:15:22Z",
  • "entityId": "string",
  • "fileName": "string",
  • "id": "string",
  • "jobType": "string",
  • "messages": [
    ],
  • "organization": "string",
  • "resourceExtension": "string",
  • "resourceLink": "string",
  • "serviceProviderId": "string",
  • "status": "PENDING",
  • "uniqueId": "string",
  • "userId": "string"
}

Get user configuration

Returns user configuration

Responses

Response samples

Content type
application/json
{
  • "dateCreated": "2019-08-24T14:15:22Z",
  • "dateUpdated": "2019-08-24T14:15:22Z",
  • "id": "string"
}

Update user configuration

Returns user configuration

Request Body schema: application/json
required
dateCreated
string <date-time>
dateUpdated
string <date-time>
id
string
object

Responses

Request samples

Content type
application/json
{
  • "dateCreated": "2019-08-24T14:15:22Z",
  • "dateUpdated": "2019-08-24T14:15:22Z",
  • "id": "string",
  • "properties": {
    }
}

Response samples

Content type
application/json
{
  • "dateCreated": "2019-08-24T14:15:22Z",
  • "dateUpdated": "2019-08-24T14:15:22Z",
  • "id": "string"
}

Get server time

Returns server time

Responses

Response samples

Content type
application/json
{ }

Get user configuration

Returns user configuration

path Parameters
userId
required
string
query Parameters
providerId
string

Responses

Response samples

Content type
application/json
{
  • "dateCreated": "2019-08-24T14:15:22Z",
  • "dateUpdated": "2019-08-24T14:15:22Z",
  • "id": "string"
}

Transformation script resource

Transformation script resource

Get transformation scripts

Returns transformation scripts that are available for organization

query Parameters
organization
required
string

Organization Id

enabled
boolean

Enabled/Disabled

Responses

Response samples

Content type
application/json
[
  • {
    }
]

Create a new transformation script

Creates a new transformation script

query Parameters
organization
required
Array of strings

Organization Id

validate
boolean
Default: false
Request Body schema: application/json
required
author
string
dateCreated
string <date-time>
dateUpdated
string <date-time>
enabled
boolean
id
string
image
string
name
required
string
organizationId
string
scriptBody
required
string
scriptType
string
Value: "GROOVY"
serviceProviderId
string
type
string
Enum: "PLAYLIST" "SIDECAR" "EPG"
version
integer <int32>

Responses

Request samples

Content type
application/json
{
  • "author": "string",
  • "dateCreated": "2019-08-24T14:15:22Z",
  • "dateUpdated": "2019-08-24T14:15:22Z",
  • "enabled": true,
  • "id": "string",
  • "image": "string",
  • "name": "string",
  • "organizationId": "string",
  • "scriptBody": "string",
  • "scriptType": "GROOVY",
  • "serviceProviderId": "string",
  • "type": "PLAYLIST",
  • "version": 0
}

Response samples

Content type
application/json
{
  • "author": "string",
  • "dateCreated": "2019-08-24T14:15:22Z",
  • "dateUpdated": "2019-08-24T14:15:22Z",
  • "enabled": true,
  • "id": "string",
  • "image": "string",
  • "name": "string",
  • "organizationId": "string",
  • "scriptBody": "string",
  • "scriptType": "GROOVY",
  • "serviceProviderId": "string",
  • "type": "PLAYLIST",
  • "version": 0
}

Update transformation script

Updates transformation script with given ID

Request Body schema: application/json
required
author
string
dateCreated
string <date-time>
dateUpdated
string <date-time>
enabled
boolean
id
string
image
string
name
required
string
organizationId
string
scriptBody
required
string
scriptType
string
Value: "GROOVY"
serviceProviderId
string
type
string
Enum: "PLAYLIST" "SIDECAR" "EPG"
version
integer <int32>

Responses

Request samples

Content type
application/json
{
  • "author": "string",
  • "dateCreated": "2019-08-24T14:15:22Z",
  • "dateUpdated": "2019-08-24T14:15:22Z",
  • "enabled": true,
  • "id": "string",
  • "image": "string",
  • "name": "string",
  • "organizationId": "string",
  • "scriptBody": "string",
  • "scriptType": "GROOVY",
  • "serviceProviderId": "string",
  • "type": "PLAYLIST",
  • "version": 0
}

Response samples

Content type
application/json
{
  • "author": "string",
  • "dateCreated": "2019-08-24T14:15:22Z",
  • "dateUpdated": "2019-08-24T14:15:22Z",
  • "enabled": true,
  • "id": "string",
  • "image": "string",
  • "name": "string",
  • "organizationId": "string",
  • "scriptBody": "string",
  • "scriptType": "GROOVY",
  • "serviceProviderId": "string",
  • "type": "PLAYLIST",
  • "version": 0
}

Search transformation scripts

Returns transformations search by provided filters

query Parameters
organization
required
string

Organization Id

Request Body schema: application/json
required
enabled
boolean
type
string
Enum: "PLAYLIST" "SIDECAR" "EPG"

Responses

Request samples

Content type
application/json
{
  • "enabled": true,
  • "type": "PLAYLIST"
}

Response samples

Content type
application/json
[
  • {
    }
]

Delete transformation script

Deletes transformation script with given ID

path Parameters
scriptId
required
string

Transformation script Id

query Parameters
organization
required
Array of strings

Organization Id

Responses

Response samples

Content type
application/json
{ }

Get transformation script

Returns transformation script with given ID

path Parameters
scriptId
required
string

Transformation script Id

query Parameters
organization
required
Array of strings

Organization Id

Responses

Response samples

Content type
application/json
{
  • "author": "string",
  • "dateCreated": "2019-08-24T14:15:22Z",
  • "dateUpdated": "2019-08-24T14:15:22Z",
  • "enabled": true,
  • "id": "string",
  • "image": "string",
  • "name": "string",
  • "organizationId": "string",
  • "scriptBody": "string",
  • "scriptType": "GROOVY",
  • "serviceProviderId": "string",
  • "type": "PLAYLIST",
  • "version": 0
}

Update transformation script

Updates transformation script with given ID

path Parameters
scriptId
required
string

Transformation script Id

query Parameters
organization
required
Array of strings

Organization Id

validate
boolean
Default: false
Request Body schema: application/json
required
author
string
dateCreated
string <date-time>
dateUpdated
string <date-time>
enabled
boolean
id
string
image
string
name
required
string
organizationId
string
scriptBody
required
string
scriptType
string
Value: "GROOVY"
serviceProviderId
string
type
string
Enum: "PLAYLIST" "SIDECAR" "EPG"
version
integer <int32>

Responses

Request samples

Content type
application/json
{
  • "author": "string",
  • "dateCreated": "2019-08-24T14:15:22Z",
  • "dateUpdated": "2019-08-24T14:15:22Z",
  • "enabled": true,
  • "id": "string",
  • "image": "string",
  • "name": "string",
  • "organizationId": "string",
  • "scriptBody": "string",
  • "scriptType": "GROOVY",
  • "serviceProviderId": "string",
  • "type": "PLAYLIST",
  • "version": 0
}

Response samples

Content type
application/json
{
  • "author": "string",
  • "dateCreated": "2019-08-24T14:15:22Z",
  • "dateUpdated": "2019-08-24T14:15:22Z",
  • "enabled": true,
  • "id": "string",
  • "image": "string",
  • "name": "string",
  • "organizationId": "string",
  • "scriptBody": "string",
  • "scriptType": "GROOVY",
  • "serviceProviderId": "string",
  • "type": "PLAYLIST",
  • "version": 0
}

Playout deployment resource

Playout deployment resource

Get playout deployment

path Parameters
playoutId
required
string

Responses

Response samples

Content type
application/json
{ }

Publish playout deployment credentials

path Parameters
playoutId
required
string
Request Body schema: application/json
required
httpPassword
string
httpUser
string

Responses

Request samples

Content type
application/json
{
  • "httpPassword": "string",
  • "httpUser": "string"
}

Response samples

Content type
application/json
{ }

Get playout deployment status

path Parameters
playoutId
required
string

Responses

Response samples

Content type
application/json
{ }

Publish playout deployment status

path Parameters
playoutId
required
string
Request Body schema: application/json
required
message
string
status
string
Enum: "MISSING" "IN_PROGRESS" "PENDING_UPGRADE" "ERROR" "READY" "DELETING"
timestamp
string <date-time>

Responses

Request samples

Content type
application/json
{
  • "message": "string",
  • "status": "MISSING",
  • "timestamp": "2019-08-24T14:15:22Z"
}

Response samples

Content type
application/json
{ }

Crypto

Crypto API

Decrypt value

Decrypt value

Request Body schema: application/json
required
string

Responses

Request samples

Content type
application/json
"string"

Response samples

Content type
application/json
"string"

Encrypt value

Encrypt value

Request Body schema: application/json
required
string

Responses

Request samples

Content type
application/json
"string"

Response samples

Content type
application/json
"string"

Playout

Playout management

Create playout

query Parameters
organization
Array of strings
Request Body schema: application/json
required
object (PlayoutAutomaticSwitchingDTO)
backupType
string
Enum: "HOT" "WARM"
object (PlayoutConfigurationDTO)
object (DeploymentRequest)
healthyPeriod
integer <int64>
object (CreateInstanceRequest)

Instance request

instanceType
string
Enum: "AWS" "AWS_PAIRED" "TELIA" "ALIBABA" "EDGE" "AZURE"
mode
string
Enum: "DEMO" "PROD"
name
string
presetId
string
type
string
Enum: "SD" "HD" "UHD"
unhealthyPeriod
integer <int64>

Responses

Request samples

Content type
application/json
{
  • "automaticSwitching": {
    },
  • "backupType": "HOT",
  • "configuration": {
    },
  • "deploymentRequest": {
    },
  • "healthyPeriod": 0,
  • "instanceRequest": {
    },
  • "instanceType": "AWS",
  • "mode": "DEMO",
  • "name": "string",
  • "presetId": "string",
  • "type": "SD",
  • "unhealthyPeriod": 0
}

Response samples

Content type
application/json
{ }

Retrieve supported playout cloud types

query Parameters
organization
string

Responses

Response samples

Content type
application/json
[
  • "AWS"
]

Get Playouts features

query Parameters
organization
Array of strings
providerId
string
Request Body schema: application/json
required
Array
string

Responses

Request samples

Content type
application/json
[
  • "string"
]

Response samples

Content type
application/json
{
  • "property1": {
    },
  • "property2": {
    }
}

Convert to version 1.0

Responses

Response samples

Content type
application/json
{ }

Retrieve supported playout cloud regions

query Parameters
organization
string

Responses

Response samples

Content type
application/json
{
  • "property1": {
    },
  • "property2": {
    }
}

Get playouts all

query Parameters
organization
Array of strings
providerId
string
apiVersion
integer <int32>
Default: 1
Request Body schema: application/json
required
Array
string

Responses

Request samples

Content type
application/json
[
  • "string"
]

Response samples

Content type
application/json
[
  • {
    }
]

Retrieve playout versions

query Parameters
vmType
string
Default: "LINUX"
Enum: "WINDOWS" "LINUX"

Responses

Response samples

Content type
application/json
[
  • {
    }
]

Get playout

path Parameters
playoutId
required
string
query Parameters
organization
Array of strings
providerId
string
apiVersion
integer <int32>
Default: 1

Responses

Response samples

Content type
application/json
{
  • "adInsertionConfigurations": [],
  • "assetExpireHours": 0,
  • "authToken": "string",
  • "automaticSwitching": {
    },
  • "avmonSettings": {
    },
  • "backup": true,
  • "backupSettings": {
    },
  • "backupType": "HOT",
  • "bandwidthLimit": 1,
  • "cacheLength": "string",
  • "caching": true,
  • "closedCaptionsPassthrough": true,
  • "complianceRecordingSettings": {
    },
  • "concurrentDownloads": 0,
  • "configuration": {
    },
  • "dateCreated": "2019-08-24T14:15:22Z",
  • "dateUpdated": "2019-08-24T14:15:22Z",
  • "deploymentInfo": {
    },
  • "emergencyTemplate": "string",
  • "enabled": true,
  • "fps": 0.1,
  • "graphicsProject": "string",
  • "graphicsProjectV2": "string",
  • "hardwareId": "string",
  • "id": "string",
  • "ignoreTimecode": true,
  • "instanceInfo": {
    },
  • "instanceType": "AWS",
  • "internal": true,
  • "ip": "string",
  • "licenseId": 0,
  • "liveInputs": [
    ],
  • "localCacheId": "string",
  • "localPlayoutId": "string",
  • "mjpegSettings": {
    },
  • "mode": "DEMO",
  • "multimediaPackage": "string",
  • "name": "string",
  • "organizationId": "string",
  • "outputs": [
    ],
  • "password": "string",
  • "port": 0,
  • "presetId": "string",
  • "previewV2Enabled": true,
  • "pushNotificationEnabled": true,
  • "rendererConfiguration": {
    },
  • "scteListenerStrategy": "IGNORE",
  • "serviceProviderId": "string",
  • "statusConfiguration": {
    },
  • "timeBarSettings": {
    },
  • "type": "SD",
  • "uploadBandwidthLimit": 1,
  • "username": "string",
  • "version": 0,
  • "zixiEnabled": true
}

Upgrade playout

path Parameters
playoutId
required
string
query Parameters
organization
Array of strings
providerId
string
Request Body schema: application/json
required
keepOldInstance
boolean

Keep old instance after replace, only usable in conjunction with replace : true

nixEnabled
boolean

Enable NIX, this will enable NIX on playout

osUpgradeAllowed
boolean

Allow OS upgrade, this will upgrade OS to latest version

reinstall
boolean

Reinstall playout this will reinstall all software on playout

replace
boolean

Replace playout instance with new one, this will create new instance and delete old one

targetCloud
string
Enum: "AWS" "AWS_PAIRED" "TELIA" "ALIBABA" "EDGE" "AZURE"

Change playout cloud type, only usable in conjunction with replace : true

targetDeployment
string
Enum: "DOCKER" "KUBERNETES"

Change playout deployment type, only usable in conjunction with replace : true

targetInstanceType
string

Change playout instance type, only usable in conjunction with replace : true

targetRegion
string

Change playout region, only usable in conjunction with replace : true

object (PlayoutVersionDTO)

Upgrade playout object

targetVolumeSize
integer <int32>

Change playout volume size, only usable in conjunction with replace : true

targetZone
string

Change playout availability zone, only usable in conjunction with replace : true

Responses

Request samples

Content type
application/json
{
  • "keepOldInstance": true,
  • "nixEnabled": true,
  • "osUpgradeAllowed": true,
  • "reinstall": true,
  • "replace": true,
  • "targetCloud": "AWS",
  • "targetDeployment": "DOCKER",
  • "targetInstanceType": "string",
  • "targetRegion": "string",
  • "targetVersion": {
    },
  • "targetVolumeSize": 0,
  • "targetZone": "string"
}

Response samples

Content type
application/json
{ }

Get playout inbound access rights

path Parameters
playoutId
required
string

Playout id

query Parameters
organization
Array of strings
providerId
string

Responses

Response samples

Content type
application/json
[
  • {
    }
]

Configure inbound access rights

path Parameters
playoutId
required
string

Playout id

query Parameters
organization
Array of strings
providerId
string
Request Body schema: application/json
required
Array
fromPort
integer <int32>
ipRange
string
name
string
port
integer <int32>
protocol
string
securityGroupId
string
toPort
integer <int32>

Responses

Request samples

Content type
application/json
[
  • {
    }
]

Response samples

Content type
application/json
{
  • "dateCreated": "2019-08-24T14:15:22Z",
  • "dateFinished": "2019-08-24T14:15:22Z",
  • "entityId": "string",
  • "fileName": "string",
  • "id": "string",
  • "jobType": "string",
  • "messages": [
    ],
  • "organization": "string",
  • "resourceExtension": "string",
  • "resourceLink": "string",
  • "serviceProviderId": "string",
  • "status": "PENDING",
  • "uniqueId": "string",
  • "userId": "string"
}

Export firewall settings as JSON

Export firewall settings into JSON format

path Parameters
playoutId
required
string
query Parameters
organization
string
providerId
string

Responses

Response samples

Content type
application/json
{ }

Get a list of playout ad insertion configurations

Returns a list of playout ad insertion configurations, with state of configuration from ad decision provider

path Parameters
playoutId
required
string

Playout id

query Parameters
organization
Array of strings
providerId
string

Responses

Response samples

Content type
application/json
[]

Bulk update playout ad insertion configuration

Returns a list of playout ad insertion configurations, synced with ad decision provider

path Parameters
playoutId
required
string

Playout id

query Parameters
organization
Array of strings
providerId
string
Request Body schema: application/json
required
Array
abrGroup
required
string

ABR group name of one or multiple playout HLS outputs

adDecisionServerUrl
required
string

Decision server url, from which to serve ad decision XML

adMarkerPassthrough
boolean
object

Aliases for ad insertion configuration

availSuppressionMode
string
Enum: "OFF" "BEHIND_LIVE_EDGE" "AFTER_LIVE_EDGE" "OFF" "BEHIND_LIVE_EDGE" "AFTER_LIVE_EDGE"

Avail suppression mode

availSuppressionValue
string

Avail suppression value, in format HH:MM:SS

bumperEndUrl
string

Bumper end url for ad insertion

bumperStartUrl
string

Bumper start url for ad insertion

cdnAdSegmentPrefix
string
cdnContentSegmentPrefix
string
dashMpdLocation
string
Enum: "EMT_DEFAULT" "DISABLED"
dashOriginType
string
Enum: "MULTI_PERIOD" "SINGLE_PERIOD"
livePrerollDecsiionServerUrl
string
livePrerollDecsionServerUrl
string

Decision server url for live preroll

livePrerollMaximumDuration
integer <int32>

Live preroll maximum duration

name
required
string

Ad insertion configuration name

personalizedThreshold
integer <int32>

Ad insertion personalized threshold

region
required
string

Ad insertion configuration region

sessionLogPercent
integer <int32> [ 0 .. 100 ]
Default: 0

Logging percent for session requests

slateAssetId
string

Asset id from library for slate asset

slateAssetUrl
string

Asset url for slate asset

transcodeProfileName
string

Transcode profile name for ad insertion

Responses

Request samples

Content type
application/json
[]

Response samples

Content type
application/json
[]

Create playout backup

path Parameters
playoutId
required
string

Playout id

query Parameters
organization
Array of strings
providerId
string
Request Body schema: application/json
required
backupType
required
string
Enum: "HOT" "WARM"
Array of objects (PlayoutGraph)
healthyPeriod
integer <int64>
object (CreateInstanceRequest)

Instance request

instanceType
required
string
Enum: "AWS" "AWS_PAIRED" "TELIA" "ALIBABA" "EDGE" "AZURE"
mode
string
Enum: "DEMO" "PROD"
name
required
string
unhealthyPeriod
integer <int64>

Responses

Request samples

Content type
application/json
{
  • "backupType": "HOT",
  • "graphs": [
    ],
  • "healthyPeriod": 0,
  • "instanceRequest": {
    },
  • "instanceType": "AWS",
  • "mode": "DEMO",
  • "name": "string",
  • "unhealthyPeriod": 0
}

Response samples

Content type
application/json
{
  • "dateCreated": "2019-08-24T14:15:22Z",
  • "dateFinished": "2019-08-24T14:15:22Z",
  • "entityId": "string",
  • "fileName": "string",
  • "id": "string",
  • "jobType": "string",
  • "messages": [
    ],
  • "organization": "string",
  • "resourceExtension": "string",
  • "resourceLink": "string",
  • "serviceProviderId": "string",
  • "status": "PENDING",
  • "uniqueId": "string",
  • "userId": "string"
}

Get playout cdn configurations

Returns a list of playout cdn configurations

path Parameters
playoutId
required
string

Playout id

query Parameters
organization
Array of strings
providerId
string

Responses

Response samples

Content type
application/json
[
  • {
    }
]

Update playout cdn configurations

Updates all playout cdn configurations, removes all that are not included in body, returns async job

path Parameters
playoutId
required
string

Playout id

query Parameters
organization
Array of strings
providerId
string
Request Body schema: application/json
required
Array
abrGroup
string

ABR group of playout's output, can only be set if adInsertionName is not set

adInsertionName
string

Ad insertion name, can only be set if abrGroup is not set

connectionAttempts
integer <int32>
connectionTimeout
integer <int32>
dateCreated
string <date-time>
dateUpdated
string <date-time>
defaultTTL
integer <int64>
id
string
keepAliveTimeout
integer <int32>
maxTTL
integer <int64>
minTTL
integer <int64>
name
string
originSegmentUrl
string
originShieldEnabled
boolean
originShieldRegion
string
responseTimeout
integer <int32>
state
string
Enum: "UNKNOWN" "PENDING_DELETION" "DELETING_IN_PROGRESS" "DELETED" "PENDING_MODIFICATION" "MODIFICATION_IN_PROGRESS" "INVALID_CONFIGURATION" "ACTIVE"

Responses

Request samples

Content type
application/json
[
  • {
    }
]

Response samples

Content type
application/json
{
  • "dateCreated": "2019-08-24T14:15:22Z",
  • "dateFinished": "2019-08-24T14:15:22Z",
  • "entityId": "string",
  • "fileName": "string",
  • "id": "string",
  • "jobType": "string",
  • "messages": [
    ],
  • "organization": "string",
  • "resourceExtension": "string",
  • "resourceLink": "string",
  • "serviceProviderId": "string",
  • "status": "PENDING",
  • "uniqueId": "string",
  • "userId": "string"
}

Clone playout

Clones existing playout, creating new copy of it

path Parameters
playoutId
required
string

Playout id

query Parameters
organization
Array of strings
providerId
string
Request Body schema: application/json
required
Array of objects (PlayoutGraph)
object (CreateInstanceRequest)

Instance request

instanceType
required
string
Enum: "AWS" "AWS_PAIRED" "TELIA" "ALIBABA" "EDGE" "AZURE"
mode
string
Enum: "DEMO" "PROD"
name
required
string

Responses

Request samples

Content type
application/json
{
  • "graphs": [
    ],
  • "instanceRequest": {
    },
  • "instanceType": "AWS",
  • "mode": "DEMO",
  • "name": "string"
}

Response samples

Content type
application/json
{
  • "dateCreated": "2019-08-24T14:15:22Z",
  • "dateFinished": "2019-08-24T14:15:22Z",
  • "entityId": "string",
  • "fileName": "string",
  • "id": "string",
  • "jobType": "string",
  • "messages": [
    ],
  • "organization": "string",
  • "resourceExtension": "string",
  • "resourceLink": "string",
  • "serviceProviderId": "string",
  • "status": "PENDING",
  • "uniqueId": "string",
  • "userId": "string"
}

Download playout related settings

Returns JSON file containing exported output or firewall settings

path Parameters
playoutId
required
string

Playout id

fileName
required
string

File name

query Parameters
organization
string

Organization Id

Responses

Response samples

Content type
application/json
{ }

Export output properties as JSON

Export output properties into JSON format

path Parameters
playoutId
required
string
query Parameters
organization
string

Organization Id

apiVersion
integer <int32>
Default: 1

Responses

Response samples

Content type
application/json
{
  • "dateCreated": "2019-08-24T14:15:22Z",
  • "dateFinished": "2019-08-24T14:15:22Z",
  • "entityId": "string",
  • "fileName": "string",
  • "id": "string",
  • "jobType": "string",
  • "messages": [
    ],
  • "organization": "string",
  • "resourceExtension": "string",
  • "resourceLink": "string",
  • "serviceProviderId": "string",
  • "status": "PENDING",
  • "uniqueId": "string",
  • "userId": "string"
}

Get Playout features

path Parameters
playoutId
required
string

Playout id

query Parameters
organization
Array of strings
providerId
string

Responses

Response samples

Content type
application/json
{
  • "aribPassthrough": true,
  • "customSubtitleStyles": true,
  • "dolby": true,
  • "instantGraphics": true,
  • "jpegXsEncoder": true,
  • "mc265Encoder": true,
  • "mpeg2": true,
  • "multipleAudioTracksSameLanguage": true,
  • "reuseVideoEncoders": true,
  • "supportAllFeature": true,
  • "timelineBlocks": true,
  • "webrtc": true,
  • "webrtcServerSelect": true
}

Export input properties as JSON

Export input properties into JSON format

path Parameters
playoutId
required
string
query Parameters
organization
string

Organization Id

apiVersion
integer <int32>

Responses

Response samples

Content type
application/json
{
  • "dateCreated": "2019-08-24T14:15:22Z",
  • "dateFinished": "2019-08-24T14:15:22Z",
  • "entityId": "string",
  • "fileName": "string",
  • "id": "string",
  • "jobType": "string",
  • "messages": [
    ],
  • "organization": "string",
  • "resourceExtension": "string",
  • "resourceLink": "string",
  • "serviceProviderId": "string",
  • "status": "PENDING",
  • "uniqueId": "string",
  • "userId": "string"
}

Change instance size

path Parameters
playoutId
required
string
query Parameters
organization
Array of strings
providerId
string
Request Body schema: application/json
required
string

Responses

Request samples

Content type
application/json
"string"

Response samples

Content type
application/json
{ }

Bulk update playout live input configuration

path Parameters
playoutId
required
string

Playout id

query Parameters
organization
Array of strings
providerId
string
apiVersion
integer <int32>
Default: 1
Request Body schema: application/json
required
Array
decoder
string
Enum: "AUTO" "AVC" "MPEG"
defaultAribOverride
boolean
defaultAudioOverride
boolean
defaultInput
boolean
delay
integer <int64>
destinationArn
string
object (PlaylistEventSCTE35Filter)
emergencyLive
boolean
enabled
boolean
encryptionKey
string
id
string
mediaFlowArn
string
normalizeLoudness
boolean
port
integer <int32>
port2
integer <int32>
presetId
string
primarySCTESource
boolean
recording
boolean
routeId
string
scteListenerStrategy
string
Deprecated
Enum: "IGNORE" "MANUAL_END" "BASED_ON_EVENT_SCTE_TRIGGER"
srtLatency
integer <int64>
srtStreamId
string
object (StreamSettingsDTO)
streamingProtocol
string
Enum: "UDP" "RTPUDP" "RTMP_SERVER" "RTMP_CLIENT" "HTTP" "HLS" "HLS_PUSH" "RTP_FEC_2D" "SRT_CALLER" "SRT_LISTENER" "CDI" "DUAL_RTP" "DUAL_RTP_FEC_2D"
synchronizeWith
string
type
string
Enum: "REGULAR" "MEDIA_CONNECT"
url
string

Responses

Request samples

Content type
application/json
[
  • {
    }
]

Response samples

Content type
application/json
{
  • "adInsertionConfigurations": [],
  • "assetExpireHours": 0,
  • "authToken": "string",
  • "automaticSwitching": {
    },
  • "avmonSettings": {
    },
  • "backup": true,
  • "backupSettings": {
    },
  • "backupType": "HOT",
  • "bandwidthLimit": 1,
  • "cacheLength": "string",
  • "caching": true,
  • "closedCaptionsPassthrough": true,
  • "complianceRecordingSettings": {
    },
  • "concurrentDownloads": 0,
  • "configuration": {
    },
  • "dateCreated": "2019-08-24T14:15:22Z",
  • "dateUpdated": "2019-08-24T14:15:22Z",
  • "deploymentInfo": {
    },
  • "emergencyTemplate": "string",
  • "enabled": true,
  • "fps": 0.1,
  • "graphicsProject": "string",
  • "graphicsProjectV2": "string",
  • "hardwareId": "string",
  • "id": "string",
  • "ignoreTimecode": true,
  • "instanceInfo": {
    },
  • "instanceType": "AWS",
  • "internal": true,
  • "ip": "string",
  • "licenseId": 0,
  • "liveInputs": [
    ],
  • "localCacheId": "string",
  • "localPlayoutId": "string",
  • "mjpegSettings": {
    },
  • "mode": "DEMO",
  • "multimediaPackage": "string",
  • "name": "string",
  • "organizationId": "string",
  • "outputs": [
    ],
  • "password": "string",
  • "port": 0,
  • "presetId": "string",
  • "previewV2Enabled": true,
  • "pushNotificationEnabled": true,
  • "rendererConfiguration": {
    },
  • "scteListenerStrategy": "IGNORE",
  • "serviceProviderId": "string",
  • "statusConfiguration": {
    },
  • "timeBarSettings": {
    },
  • "type": "SD",
  • "uploadBandwidthLimit": 1,
  • "username": "string",
  • "version": 0,
  • "zixiEnabled": true
}

List mediaconnect flows

path Parameters
playoutId
required
string

Playout id

query Parameters
organization
Array of strings
providerId
string

Responses

Response samples

Content type
application/json
[
  • {
    }
]

Reboot playout

path Parameters
playoutId
required
string
query Parameters
organization
Array of strings
providerId
string

Responses

Response samples

Content type
application/json
{ }

Get a list of playout outputs

path Parameters
playoutId
required
string

Playout id

query Parameters
organization
Array of strings
providerId
string
fetchFromPlayout
boolean
apiVersion
integer <int32>
Default: 1

Responses

Response samples

Content type
application/json
[
  • {
    }
]

Bulk update playout output configuration

path Parameters
playoutId
required
string

Playout id

query Parameters
organization
Array of strings
providerId
string
rebootImmediately
boolean
apiVersion
integer <int32>
Default: 1
Request Body schema: application/json
required
Array
Array of objects (AudioStreamSettingsDTO)
Array of objects (NameLang)
Array of objects (ContentAdvisoryType) unique
disableOnEmergency
boolean
disableOnEmergencyDelayMs
integer <int32>
enabled
boolean
Deprecated
object (EncoderSettings)
ignoreComplianceRecording
boolean
Deprecated
Array of objects (MediaConnectDestination) unique
Deprecated
mediaConnectFlowArn
string
Deprecated
object (MuxerSettings)
name
string
Array of objects (OutputStream)
presetId
string
object (StreamSettingsDTO)
Array of objects (NameLangStyle)
Array of objects (NameLang)
Array of objects (NameLang)
Array of objects (LangStyle)
Array of objects (NameLang)
object (TransportSettings)
type
string
Deprecated
Enum: "REGULAR" "PREVIEW" "MEDIA_CONNECT"
object (VideoCaps)

Responses

Request samples

Content type
application/json
[
  • {
    }
]

Response samples

Content type
application/json
{ }

Get playout system password

path Parameters
playoutId
required
string
query Parameters
organization
Array of strings
providerId
string

Responses

Response samples

Content type
application/json
{
  • "ip": "string",
  • "nginxPassword": "string",
  • "nginxUser": "string",
  • "sshKey": "string",
  • "systemPassword": "string",
  • "systemUser": "string"
}

Reboot playout

path Parameters
playoutId
required
string
query Parameters
organization
Array of strings
providerId
string

Responses

Response samples

Content type
application/json
{ }

Reset failed instance to default state

path Parameters
playoutId
required
string
query Parameters
organization
Array of strings
providerId
string
Request Body schema: application/json
required
keepOldInstance
boolean

Keep old instance after replace, only usable in conjunction with replace : true

nixEnabled
boolean

Enable NIX, this will enable NIX on playout

osUpgradeAllowed
boolean

Allow OS upgrade, this will upgrade OS to latest version

reinstall
boolean

Reinstall playout this will reinstall all software on playout

replace
boolean

Replace playout instance with new one, this will create new instance and delete old one

targetCloud
string
Enum: "AWS" "AWS_PAIRED" "TELIA" "ALIBABA" "EDGE" "AZURE"

Change playout cloud type, only usable in conjunction with replace : true

targetDeployment
string
Enum: "DOCKER" "KUBERNETES"

Change playout deployment type, only usable in conjunction with replace : true

targetInstanceType
string

Change playout instance type, only usable in conjunction with replace : true

targetRegion
string

Change playout region, only usable in conjunction with replace : true

object (PlayoutVersionDTO)

Upgrade playout object

targetVolumeSize
integer <int32>

Change playout volume size, only usable in conjunction with replace : true

targetZone
string

Change playout availability zone, only usable in conjunction with replace : true

Responses

Request samples

Content type
application/json
{
  • "keepOldInstance": true,
  • "nixEnabled": true,
  • "osUpgradeAllowed": true,
  • "reinstall": true,
  • "replace": true,
  • "targetCloud": "AWS",
  • "targetDeployment": "DOCKER",
  • "targetInstanceType": "string",
  • "targetRegion": "string",
  • "targetVersion": {
    },
  • "targetVolumeSize": 0,
  • "targetZone": "string"
}

Response samples

Content type
application/json
{ }

Get a list of playout scte-35 triggers

path Parameters
playoutId
required
string

Playout id

query Parameters
organization
Array of strings
providerId
string

Responses

Response samples

Content type
application/json
[
  • {
    }
]

Modify playout scte-35 triggers

path Parameters
playoutId
required
string

Playout id

query Parameters
organization
Array of strings
providerId
string
Request Body schema: application/json
required
Array of objects (PlayoutSCTE35Trigger)
deleted
Array of strings
Array of objects (PlayoutSCTE35Trigger)

Responses

Request samples

Content type
application/json
{
  • "created": [
    ],
  • "deleted": [
    ],
  • "updated": [
    ]
}

Response samples

Content type
application/json
[
  • {
    }
]

Upgrade playout service Deprecated

This method is deprecated. Use PUT /playout/{playoutId}instead

path Parameters
playoutId
required
string
serviceName
required
string
query Parameters
organization
Array of strings
providerId
string
Request Body schema: application/json
required
build
string
Array of objects (VersionChangelog) unique
dateCreated
string <date-time>
environment
string
id
string
major
integer <int32>
minor
integer <int32>
sprint
integer <int32>
status
string
Enum: "STABLE" "FEATURE" "UNSTABLE"
versionString
string
vmType
string
Enum: "WINDOWS" "LINUX"

Responses

Request samples

Content type
application/json
{
  • "build": "string",
  • "changelog": [
    ],
  • "dateCreated": "2019-08-24T14:15:22Z",
  • "environment": "string",
  • "id": "string",
  • "major": 0,
  • "minor": 0,
  • "sprint": 0,
  • "status": "STABLE",
  • "versionString": "string",
  • "vmType": "WINDOWS"
}

Response samples

Content type
application/json
{ }

Connection status check

path Parameters
playoutId
required
string

Playout id

Request Body schema: application/json
required
accessKey
string
containerName
string
encryptionKey
string
errorCorrectionOverhead
integer <int32>
fecColumns
integer <int32>
fecRows
integer <int32>
hlsAbrGroup
string
hlsAbrUrl
string
hlsPushDestinationType
string
Enum: "WEBDAV" "MEDIA_PACKAGE" "S3" "S3_PAIRED"
hlsPushPassword
string
hlsPushUser
string
hlsSegmentCount
integer <int32>
hlsSegmentDuration
number <float>
hlsSegmentTtl
integer <int32>
host
string
host2
string
insertScte35IntoMpegTs
boolean
mediaConnectOutputIp
string
mediaconnectHost
string
outputName
string
outputStreamName
string
password
string
port
integer <int32>
port2
integer <int32>
region
string
scteAheadTimes
Array of integers <int64> [ items <int64 > ]
scteNullInterval
integer <int32>
scteNullPeriod
integer <int64>
scteTagFormat
string
Enum: "NONE" "ADOBE" "ELEMENTAL" "ENHANCED" "GOOGLE_AD_MANAGER" "ZAPPN" "MPEG_TS" "GOOGLE_AD_MANAGER_INCL_DATETIME" "ENHANCED_INCL_DATETIME"
secretKey
string
sourcePath
string
srtLatency
integer <int64>
srtStreamId
string
transportType
string
Enum: "UDP" "RTPUDP" "RTMP_SERVER" "RTMP_CLIENT" "HTTP" "HLS" "HLS_PUSH" "RTP_FEC_2D" "SRT_CALLER" "SRT_LISTENER" "CDI" "DUAL_RTP" "DUAL_RTP_FEC_2D"
username
string

Responses

Request samples

Content type
application/json
{
  • "accessKey": "string",
  • "containerName": "string",
  • "encryptionKey": "string",
  • "errorCorrectionOverhead": 0,
  • "fecColumns": 0,
  • "fecRows": 0,
  • "hlsAbrGroup": "string",
  • "hlsAbrUrl": "string",
  • "hlsPushDestinationType": "WEBDAV",
  • "hlsPushPassword": "string",
  • "hlsPushUser": "string",
  • "hlsSegmentCount": 0,
  • "hlsSegmentDuration": 0.1,
  • "hlsSegmentTtl": 0,
  • "host": "string",
  • "host2": "string",
  • "insertScte35IntoMpegTs": true,
  • "mediaConnectOutputIp": "string",
  • "mediaconnectHost": "string",
  • "outputName": "string",
  • "outputStreamName": "string",
  • "password": "string",
  • "port": 0,
  • "port2": 0,
  • "region": "string",
  • "scteAheadTimes": [
    ],
  • "scteNullInterval": 0,
  • "scteNullPeriod": 0,
  • "scteTagFormat": "NONE",
  • "secretKey": "string",
  • "sourcePath": "string",
  • "srtLatency": 0,
  • "srtStreamId": "string",
  • "transportType": "UDP",
  • "username": "string"
}

Response samples

Content type
application/json
{
  • "message": "string",
  • "status": "OK"
}

Configure zixi licenses

path Parameters
playoutId
required
string

Playout id

query Parameters
organization
Array of strings
providerId
string
Request Body schema: application/json
required
mcFeederEnabled
boolean
mcFeederLicense
string
mcReceiverEnabled
boolean
mcReceiverLicense
string

Responses

Request samples

Content type
application/json
{
  • "mcFeederEnabled": true,
  • "mcFeederLicense": "string",
  • "mcReceiverEnabled": true,
  • "mcReceiverLicense": "string"
}

Response samples

Content type
application/json
{
  • "dateCreated": "2019-08-24T14:15:22Z",
  • "dateFinished": "2019-08-24T14:15:22Z",
  • "entityId": "string",
  • "fileName": "string",
  • "id": "string",
  • "jobType": "string",
  • "messages": [
    ],
  • "organization": "string",
  • "resourceExtension": "string",
  • "resourceLink": "string",
  • "serviceProviderId": "string",
  • "status": "PENDING",
  • "uniqueId": "string",
  • "userId": "string"
}

Retrieve playout latest version

path Parameters
type
required
string
Enum: "WINDOWS" "LINUX"

Responses

Response samples

Content type
application/json
{
  • "build": "string",
  • "changelog": [
    ],
  • "dateCreated": "2019-08-24T14:15:22Z",
  • "dateUpdated": "2019-08-24T14:15:22Z",
  • "environment": "string",
  • "id": "string",
  • "major": 0,
  • "minor": 0,
  • "organizationId": "string",
  • "serviceProviderId": "string",
  • "sprint": 0,
  • "status": "STABLE",
  • "versionString": "string",
  • "vmType": "WINDOWS"
}

Create playout version

path Parameters
type
required
string
Enum: "WINDOWS" "LINUX"
Request Body schema: application/json
required
build
string
Array of objects (VersionChangelog) unique
dateCreated
string <date-time>
dateUpdated
string <date-time>
environment
string
id
string
major
integer <int32>
minor
integer <int32>
organizationId
string
serviceProviderId
string
sprint
integer <int32>
status
string
Enum: "STABLE" "FEATURE" "UNSTABLE"
versionString
string
vmType
string
Enum: "WINDOWS" "LINUX"

Responses

Request samples

Content type
application/json
{
  • "build": "string",
  • "changelog": [
    ],
  • "dateCreated": "2019-08-24T14:15:22Z",
  • "dateUpdated": "2019-08-24T14:15:22Z",
  • "environment": "string",
  • "id": "string",
  • "major": 0,
  • "minor": 0,
  • "organizationId": "string",
  • "serviceProviderId": "string",
  • "sprint": 0,
  • "status": "STABLE",
  • "versionString": "string",
  • "vmType": "WINDOWS"
}

Response samples

Content type
application/json
{
  • "build": "string",
  • "changelog": [
    ],
  • "dateCreated": "2019-08-24T14:15:22Z",
  • "dateUpdated": "2019-08-24T14:15:22Z",
  • "environment": "string",
  • "id": "string",
  • "major": 0,
  • "minor": 0,
  • "organizationId": "string",
  • "serviceProviderId": "string",
  • "sprint": 0,
  • "status": "STABLE",
  • "versionString": "string",
  • "vmType": "WINDOWS"
}

Retrieve latest stable playout version

path Parameters
type
required
string
Enum: "WINDOWS" "LINUX"

Responses

Response samples

Content type
application/json
{
  • "build": "string",
  • "changelog": [
    ],
  • "dateCreated": "2019-08-24T14:15:22Z",
  • "dateUpdated": "2019-08-24T14:15:22Z",
  • "environment": "string",
  • "id": "string",
  • "major": 0,
  • "minor": 0,
  • "organizationId": "string",
  • "serviceProviderId": "string",
  • "sprint": 0,
  • "status": "STABLE",
  • "versionString": "string",
  • "vmType": "WINDOWS"
}

Delete playout version

path Parameters
type
required
string
Enum: "WINDOWS" "LINUX"
id
required
string

Responses

Response samples

Content type
application/json
{
  • "code": 0,
  • "messages": [
    ]
}

Update playout version status

path Parameters
type
required
string
Enum: "WINDOWS" "LINUX"
id
required
string
Request Body schema: application/json
required
build
string
Array of objects (VersionChangelog) unique
dateCreated
string <date-time>
dateUpdated
string <date-time>
environment
string
id
string
major
integer <int32>
minor
integer <int32>
organizationId
string
serviceProviderId
string
sprint
integer <int32>
status
string
Enum: "STABLE" "FEATURE" "UNSTABLE"
versionString
string
vmType
string
Enum: "WINDOWS" "LINUX"

Responses

Request samples

Content type
application/json
{
  • "build": "string",
  • "changelog": [
    ],
  • "dateCreated": "2019-08-24T14:15:22Z",
  • "dateUpdated": "2019-08-24T14:15:22Z",
  • "environment": "string",
  • "id": "string",
  • "major": 0,
  • "minor": 0,
  • "organizationId": "string",
  • "serviceProviderId": "string",
  • "sprint": 0,
  • "status": "STABLE",
  • "versionString": "string",
  • "vmType": "WINDOWS"
}

Response samples

Content type
application/json
{
  • "build": "string",
  • "changelog": [
    ],
  • "dateCreated": "2019-08-24T14:15:22Z",
  • "dateUpdated": "2019-08-24T14:15:22Z",
  • "environment": "string",
  • "id": "string",
  • "major": 0,
  • "minor": 0,
  • "organizationId": "string",
  • "serviceProviderId": "string",
  • "sprint": 0,
  • "status": "STABLE",
  • "versionString": "string",
  • "vmType": "WINDOWS"
}

Playout configuration resource

Playout configuration resource

Get playouts for organization

Returns playouts

query Parameters
organization
Array of strings
providerId
string
apiVersion
integer <int32>
Default: 1
emergencyPlaylist
string

Search by emergencyPlaylist asset name.

placeholderPlaylist
string

Search by placeholderPlaylist asset name.

graphicsProject
string

Search by graphicsProject.

emergencyTemplate
string

Search by emergencyTemplate.

name
string

Search by playout name

readyOnly
boolean

Search for running instances

enabled
boolean

Search by enabled flag

backup
boolean

Search by backup flag

unassigned
boolean

Search for playouts not assigned to any organization

instanceTypes
string

Search by instance types

backupSettings.backupPlayoutIds
string

Search by backup playout ids

Responses

Response samples

Content type
application/json
[
  • {
    }
]

Get emergency playlist assets

Returns emergency playlist assets of a playout.

query Parameters
organizationId
required
string

Responses

Response samples

Content type
application/json
[
  • "string"
]

Get placeholder playlist assets

Returns placeholder playlist assets of a playout.

query Parameters
organizationId
required
string

Responses

Response samples

Content type
application/json
[
  • "string"
]

Search for playouts

Returns playouts

query Parameters
organization
Array of strings
providerId
string
apiVersion
integer <int32>
Default: 1
size
integer

Number of items per page (defaults to 20)

page
integer

Page number (defaults to 0)

sort
string

Properties that should be sorted by in the format property,property(,ASC|DESC). Default sort direction is ascending. Use multiple sort parameters if you want to switch directions, e.g. ?sort=firstname&sort=lastname,asc

Request Body schema: application/json
object (PlayoutAutomaticSwitchingSearch)
backup
boolean
object (BackupSettingsSearch)
channelName
string
deprecatedVersion
boolean
emergencyPlaylist
Array of strings
emergencyTemplate
string
enabled
boolean
graphicsProject
string
graphicsProjectV2
string
object (PlayoutInstanceInfoSearch)
instanceTypes
Array of strings unique
Items Enum: "AWS" "AWS_PAIRED" "TELIA" "ALIBABA" "EDGE" "AZURE"
mode
string
Enum: "DEMO" "PROD"
multimediaPackage
string
name
string
placeholderPlaylist
Array of strings
readyOnly
boolean
object (PlayoutStatusSearch)
unassigned
boolean

Responses

Request samples

Content type
application/json
{
  • "automaticSwitching": {
    },
  • "backup": true,
  • "backupSettings": {
    },
  • "channelName": "string",
  • "deprecatedVersion": true,
  • "emergencyPlaylist": [
    ],
  • "emergencyTemplate": "string",
  • "enabled": true,
  • "graphicsProject": "string",
  • "graphicsProjectV2": "string",
  • "instanceInfo": {
    },
  • "instanceTypes": [
    ],
  • "mode": "DEMO",
  • "multimediaPackage": "string",
  • "name": "string",
  • "placeholderPlaylist": [
    ],
  • "readyOnly": true,
  • "status": {
    },
  • "unassigned": true
}

Response samples

Content type
application/json
{
  • "content": [
    ],
  • "empty": true,
  • "first": true,
  • "last": true,
  • "number": 0,
  • "numberOfElements": 0,
  • "pageable": {
    },
  • "size": 0,
  • "sort": [
    ],
  • "totalElements": 0,
  • "totalPages": 0
}

Get playouts by id

Returns playouts

query Parameters
organization
Array of strings
apiVersion
integer <int32>
Default: 1
Request Body schema: application/json
required
Array
string

Responses

Request samples

Content type
application/json
[
  • "string"
]

Response samples

Content type
application/json
[
  • {
    }
]

Delete playout

Delete playout by Id

path Parameters
playoutId
required
string

Playout id

query Parameters
organization
required
Array of strings
providerId
string

Responses

Response samples

Content type
application/json
{
  • "dateCreated": "2019-08-24T14:15:22Z",
  • "dateFinished": "2019-08-24T14:15:22Z",
  • "entityId": "string",
  • "fileName": "string",
  • "id": "string",
  • "jobType": "string",
  • "messages": [
    ],
  • "organization": "string",
  • "resourceExtension": "string",
  • "resourceLink": "string",
  • "serviceProviderId": "string",
  • "status": "PENDING",
  • "uniqueId": "string",
  • "userId": "string"
}

Get playout

Returns playout

path Parameters
playoutId
required
string

Playout id

query Parameters
providerId
string
organization
Array of strings
apiVersion
integer <int32>
Default: 1

Responses

Response samples

Content type
application/json
{
  • "adInsertionConfigurations": [],
  • "assetExpireHours": 0,
  • "authToken": "string",
  • "automaticSwitching": {
    },
  • "avmonSettings": {
    },
  • "backup": true,
  • "backupSettings": {
    },
  • "backupType": "HOT",
  • "bandwidthLimit": 1,
  • "cacheLength": "string",
  • "caching": true,
  • "closedCaptionsPassthrough": true,
  • "complianceRecordingSettings": {
    },
  • "concurrentDownloads": 0,
  • "configuration": {
    },
  • "dateCreated": "2019-08-24T14:15:22Z",
  • "dateUpdated": "2019-08-24T14:15:22Z",
  • "deploymentInfo": {
    },
  • "emergencyTemplate": "string",
  • "enabled": true,
  • "fps": 0.1,
  • "graphicsProject": "string",
  • "graphicsProjectV2": "string",
  • "hardwareId": "string",
  • "id": "string",
  • "ignoreTimecode": true,
  • "instanceInfo": {
    },
  • "instanceType": "AWS",
  • "internal": true,
  • "ip": "string",
  • "licenseId": 0,
  • "liveInputs": [
    ],
  • "localCacheId": "string",
  • "localPlayoutId": "string",
  • "mjpegSettings": {
    },
  • "mode": "DEMO",
  • "multimediaPackage": "string",
  • "name": "string",
  • "organizationId": "string",
  • "outputs": [
    ],
  • "password": "string",
  • "port": 0,
  • "presetId": "string",
  • "previewV2Enabled": true,
  • "pushNotificationEnabled": true,
  • "rendererConfiguration": {
    },
  • "scteListenerStrategy": "IGNORE",
  • "serviceProviderId": "string",
  • "statusConfiguration": {
    },
  • "timeBarSettings": {
    },
  • "type": "SD",
  • "uploadBandwidthLimit": 1,
  • "username": "string",
  • "version": 0,
  • "zixiEnabled": true
}

Update playout

Update playout

path Parameters
playoutId
required
string
query Parameters
providerId
string
organization
required
Array of strings
apiVersion
integer <int32>
Default: 1
Request Body schema: application/json
required
Array of objects (AdInsertionConfiguration)
assetExpireHours
integer <int32>
authToken
string
object (PlayoutAutomaticSwitchingDTO)
object (PlayoutAvmonSettingsDTO)
backup
boolean
object (PlayoutBackupSettingsDTO)
backupType
string
Enum: "HOT" "WARM"
bandwidthLimit
integer <int64> >= 1
cacheLength
string
caching
boolean
closedCaptionsPassthrough
boolean
object (PlayoutComplianceRecordingSettings)
concurrentDownloads
integer <int32>
object (PlayoutConfigurationDTO)
dateCreated
string <date-time>
dateUpdated
string <date-time>
object (DeploymentInfo)
emergencyTemplate
string
enabled
boolean
fps
number <double>
graphicsProject
string
graphicsProjectV2
string
hardwareId
string
Deprecated
id
string
ignoreTimecode
boolean
object (InstanceInfoDTO)
instanceType
string
Enum: "AWS" "AWS_PAIRED" "TELIA" "ALIBABA" "EDGE" "AZURE"
internal
boolean
ip
string
licenseId
integer <int32>
Array of objects (PlayoutLiveInputDTO)
localCacheId
string
localPlayoutId
string
object (PlayoutMjpegSettingsDTO)
mode
required
string
Enum: "DEMO" "PROD"
multimediaPackage
string
name
required
string
organizationId
string
Array of objects (PlayoutOutputDTO)
password
string
port
integer <int32>
presetId
string
previewV2Enabled
boolean
pushNotificationEnabled
boolean
object (RendererConfiguration)
scteListenerStrategy
string
Enum: "IGNORE" "MANUAL_END" "SCTE_TRIGGER" "LIVE_SWITCHING" "LIVE_SWITCHING_FAST"
serviceProviderId
string
object (StatusConfiguration)
object (PlayoutTimeBarSettingsDTO)
type
string
Enum: "SD" "HD" "UHD"
uploadBandwidthLimit
integer <int64> >= 1
username
string
version
integer <int32>
zixiEnabled
boolean

Responses

Request samples

Content type
application/json
{
  • "adInsertionConfigurations": [],
  • "assetExpireHours": 0,
  • "authToken": "string",
  • "automaticSwitching": {
    },
  • "avmonSettings": {
    },
  • "backup": true,
  • "backupSettings": {
    },
  • "backupType": "HOT",
  • "bandwidthLimit": 1,
  • "cacheLength": "string",
  • "caching": true,
  • "closedCaptionsPassthrough": true,
  • "complianceRecordingSettings": {
    },
  • "concurrentDownloads": 0,
  • "configuration": {
    },
  • "dateCreated": "2019-08-24T14:15:22Z",
  • "dateUpdated": "2019-08-24T14:15:22Z",
  • "deploymentInfo": {
    },
  • "emergencyTemplate": "string",
  • "enabled": true,
  • "fps": 0.1,
  • "graphicsProject": "string",
  • "graphicsProjectV2": "string",
  • "hardwareId": "string",
  • "id": "string",
  • "ignoreTimecode": true,
  • "instanceInfo": {
    },
  • "instanceType": "AWS",
  • "internal": true,
  • "ip": "string",
  • "licenseId": 0,
  • "liveInputs": [
    ],
  • "localCacheId": "string",
  • "localPlayoutId": "string",
  • "mjpegSettings": {
    },
  • "mode": "DEMO",
  • "multimediaPackage": "string",
  • "name": "string",
  • "organizationId": "string",
  • "outputs": [
    ],
  • "password": "string",
  • "port": 0,
  • "presetId": "string",
  • "previewV2Enabled": true,
  • "pushNotificationEnabled": true,
  • "rendererConfiguration": {
    },
  • "scteListenerStrategy": "IGNORE",
  • "serviceProviderId": "string",
  • "statusConfiguration": {
    },
  • "timeBarSettings": {
    },
  • "type": "SD",
  • "uploadBandwidthLimit": 1,
  • "username": "string",
  • "version": 0,
  • "zixiEnabled": true
}

Response samples

Content type
application/json
{
  • "adInsertionConfigurations": [],
  • "assetExpireHours": 0,
  • "authToken": "string",
  • "automaticSwitching": {
    },
  • "avmonSettings": {
    },
  • "backup": true,
  • "backupSettings": {
    },
  • "backupType": "HOT",
  • "bandwidthLimit": 1,
  • "cacheLength": "string",
  • "caching": true,
  • "closedCaptionsPassthrough": true,
  • "complianceRecordingSettings": {
    },
  • "concurrentDownloads": 0,
  • "configuration": {
    },
  • "dateCreated": "2019-08-24T14:15:22Z",
  • "dateUpdated": "2019-08-24T14:15:22Z",
  • "deploymentInfo": {
    },
  • "emergencyTemplate": "string",
  • "enabled": true,
  • "fps": 0.1,
  • "graphicsProject": "string",
  • "graphicsProjectV2": "string",
  • "hardwareId": "string",
  • "id": "string",
  • "ignoreTimecode": true,
  • "instanceInfo": {
    },
  • "instanceType": "AWS",
  • "internal": true,
  • "ip": "string",
  • "licenseId": 0,
  • "liveInputs": [
    ],
  • "localCacheId": "string",
  • "localPlayoutId": "string",
  • "mjpegSettings": {
    },
  • "mode": "DEMO",
  • "multimediaPackage": "string",
  • "name": "string",
  • "organizationId": "string",
  • "outputs": [
    ],
  • "password": "string",
  • "port": 0,
  • "presetId": "string",
  • "previewV2Enabled": true,
  • "pushNotificationEnabled": true,
  • "rendererConfiguration": {
    },
  • "scteListenerStrategy": "IGNORE",
  • "serviceProviderId": "string",
  • "statusConfiguration": {
    },
  • "timeBarSettings": {
    },
  • "type": "SD",
  • "uploadBandwidthLimit": 1,
  • "username": "string",
  • "version": 0,
  • "zixiEnabled": true
}

Assign playout to organization

Assign playout to organization by Id

path Parameters
playoutId
required
string

Playout id

query Parameters
providerId
string
apiVersion
integer <int32>
Default: 1
Request Body schema: application/json
required
string

Responses

Request samples

Content type
application/json
"string"

Response samples

Content type
application/json
{
  • "adInsertionConfigurations": [],
  • "assetExpireHours": 0,
  • "authToken": "string",
  • "automaticSwitching": {
    },
  • "avmonSettings": {
    },
  • "backup": true,
  • "backupSettings": {
    },
  • "backupType": "HOT",
  • "bandwidthLimit": 1,
  • "cacheLength": "string",
  • "caching": true,
  • "closedCaptionsPassthrough": true,
  • "complianceRecordingSettings": {
    },
  • "concurrentDownloads": 0,
  • "configuration": {
    },
  • "dateCreated": "2019-08-24T14:15:22Z",
  • "dateUpdated": "2019-08-24T14:15:22Z",
  • "deploymentInfo": {
    },
  • "emergencyTemplate": "string",
  • "enabled": true,
  • "fps": 0.1,
  • "graphicsProject": "string",
  • "graphicsProjectV2": "string",
  • "hardwareId": "string",
  • "id": "string",
  • "ignoreTimecode": true,
  • "instanceInfo": {
    },
  • "instanceType": "AWS",
  • "internal": true,
  • "ip": "string",
  • "licenseId": 0,
  • "liveInputs": [
    ],
  • "localCacheId": "string",
  • "localPlayoutId": "string",
  • "mjpegSettings": {
    },
  • "mode": "DEMO",
  • "multimediaPackage": "string",
  • "name": "string",
  • "organizationId": "string",
  • "outputs": [
    ],
  • "password": "string",
  • "port": 0,
  • "presetId": "string",
  • "previewV2Enabled": true,
  • "pushNotificationEnabled": true,
  • "rendererConfiguration": {
    },
  • "scteListenerStrategy": "IGNORE",
  • "serviceProviderId": "string",
  • "statusConfiguration": {
    },
  • "timeBarSettings": {
    },
  • "type": "SD",
  • "uploadBandwidthLimit": 1,
  • "username": "string",
  • "version": 0,
  • "zixiEnabled": true
}

Updates playout warm backup failover state

path Parameters
playoutId
required
string

Updated playout object

query Parameters
organization
Array of strings
providerId
string
apiVersion
integer <int32>
Default: 1
Request Body schema: application/json
required
boolean

Responses

Request samples

Content type
application/json
true

Response samples

Content type
application/json
{
  • "adInsertionConfigurations": [],
  • "assetExpireHours": 0,
  • "authToken": "string",
  • "automaticSwitching": {
    },
  • "avmonSettings": {
    },
  • "backup": true,
  • "backupSettings": {
    },
  • "backupType": "HOT",
  • "bandwidthLimit": 1,
  • "cacheLength": "string",
  • "caching": true,
  • "closedCaptionsPassthrough": true,
  • "complianceRecordingSettings": {
    },
  • "concurrentDownloads": 0,
  • "configuration": {
    },
  • "dateCreated": "2019-08-24T14:15:22Z",
  • "dateUpdated": "2019-08-24T14:15:22Z",
  • "deploymentInfo": {
    },
  • "emergencyTemplate": "string",
  • "enabled": true,
  • "fps": 0.1,
  • "graphicsProject": "string",
  • "graphicsProjectV2": "string",
  • "hardwareId": "string",
  • "id": "string",
  • "ignoreTimecode": true,
  • "instanceInfo": {
    },
  • "instanceType": "AWS",
  • "internal": true,
  • "ip": "string",
  • "licenseId": 0,
  • "liveInputs": [
    ],
  • "localCacheId": "string",
  • "localPlayoutId": "string",
  • "mjpegSettings": {
    },
  • "mode": "DEMO",
  • "multimediaPackage": "string",
  • "name": "string",
  • "organizationId": "string",
  • "outputs": [
    ],
  • "password": "string",
  • "port": 0,
  • "presetId": "string",
  • "previewV2Enabled": true,
  • "pushNotificationEnabled": true,
  • "rendererConfiguration": {
    },
  • "scteListenerStrategy": "IGNORE",
  • "serviceProviderId": "string",
  • "statusConfiguration": {
    },
  • "timeBarSettings": {
    },
  • "type": "SD",
  • "uploadBandwidthLimit": 1,
  • "username": "string",
  • "version": 0,
  • "zixiEnabled": true
}

Apply block

Applies block to a playout

path Parameters
playoutId
required
string

Playout id

query Parameters
organizationId
required
string
Request Body schema: application/json
required
Array
dateCreated
string <date-time>
dateUpdated
string <date-time>
Array of objects (BlockEventDTO)
fps
number <float>
id
integer <int64>
name
string
version
integer <int32>

Responses

Request samples

Content type
application/json
[
  • {
    }
]

Response samples

Content type
application/json
{ }

Updates playout warm backup caching state

path Parameters
playoutId
required
string

Updated playout object

query Parameters
organization
required
Array of strings
providerId
string
apiVersion
integer <int32>
Default: 1
Request Body schema: application/json
required
boolean

Responses

Request samples

Content type
application/json
true

Response samples

Content type
application/json
{
  • "adInsertionConfigurations": [],
  • "assetExpireHours": 0,
  • "authToken": "string",
  • "automaticSwitching": {
    },
  • "avmonSettings": {
    },
  • "backup": true,
  • "backupSettings": {
    },
  • "backupType": "HOT",
  • "bandwidthLimit": 1,
  • "cacheLength": "string",
  • "caching": true,
  • "closedCaptionsPassthrough": true,
  • "complianceRecordingSettings": {
    },
  • "concurrentDownloads": 0,
  • "configuration": {
    },
  • "dateCreated": "2019-08-24T14:15:22Z",
  • "dateUpdated": "2019-08-24T14:15:22Z",
  • "deploymentInfo": {
    },
  • "emergencyTemplate": "string",
  • "enabled": true,
  • "fps": 0.1,
  • "graphicsProject": "string",
  • "graphicsProjectV2": "string",
  • "hardwareId": "string",
  • "id": "string",
  • "ignoreTimecode": true,
  • "instanceInfo": {
    },
  • "instanceType": "AWS",
  • "internal": true,
  • "ip": "string",
  • "licenseId": 0,
  • "liveInputs": [
    ],
  • "localCacheId": "string",
  • "localPlayoutId": "string",
  • "mjpegSettings": {
    },
  • "mode": "DEMO",
  • "multimediaPackage": "string",
  • "name": "string",
  • "organizationId": "string",
  • "outputs": [
    ],
  • "password": "string",
  • "port": 0,
  • "presetId": "string",
  • "previewV2Enabled": true,
  • "pushNotificationEnabled": true,
  • "rendererConfiguration": {
    },
  • "scteListenerStrategy": "IGNORE",
  • "serviceProviderId": "string",
  • "statusConfiguration": {
    },
  • "timeBarSettings": {
    },
  • "type": "SD",
  • "uploadBandwidthLimit": 1,
  • "username": "string",
  • "version": 0,
  • "zixiEnabled": true
}

Clear playout

Clears timeline, removes all configuration like graphics project, emergency playouts etc.

path Parameters
playoutId
required
string

Playout id

query Parameters
organizationId
required
string

Responses

Response samples

Content type
application/json
{ }

Apply playout configuration

Applies default channel configuration to a playout. This method should only be used by internal services

path Parameters
playoutId
required
string

Playout id

query Parameters
organizationId
required
string
Request Body schema: application/json
required
object (PlayoutFallbackLanguages)
audioLoudness
number <float>
audioLoudnessNormalizationEnabled
boolean
channelId
string
channelName
string
gapOverlap
integer <int64>
hdPreviewEnabled
boolean
object (LiveRecordingSettings)
organizationId
string
organizationName
string
playoutId
string
playoutName
string
providerId
string
providerName
string
rtmpPreviewEnabled
boolean
object (StunServerDTO)
timelineType
string
Enum: "NIMBUS" "CIRRUS"

Responses

Request samples

Content type
application/json
{
  • "audioFallbackLanguages": {
    },
  • "audioLoudness": 0.1,
  • "audioLoudnessNormalizationEnabled": true,
  • "channelId": "string",
  • "channelName": "string",
  • "gapOverlap": 0,
  • "hdPreviewEnabled": true,
  • "liveRecordingSettings": {
    },
  • "organizationId": "string",
  • "organizationName": "string",
  • "playoutId": "string",
  • "playoutName": "string",
  • "providerId": "string",
  • "providerName": "string",
  • "rtmpPreviewEnabled": true,
  • "stunServer": {
    },
  • "timelineType": "NIMBUS"
}

Response samples

Content type
application/json
{ }

Delete playout

Delete playout by Id

path Parameters
playoutId
required
string

Playout id

query Parameters
organization
required
Array of strings
providerId
string
Request Body schema: application/json
required
string

Responses

Request samples

Content type
application/json
"string"

Response samples

Content type
application/json
{
  • "dateCreated": "2019-08-24T14:15:22Z",
  • "dateFinished": "2019-08-24T14:15:22Z",
  • "entityId": "string",
  • "fileName": "string",
  • "id": "string",
  • "jobType": "string",
  • "messages": [
    ],
  • "organization": "string",
  • "resourceExtension": "string",
  • "resourceLink": "string",
  • "serviceProviderId": "string",
  • "status": "PENDING",
  • "uniqueId": "string",
  • "userId": "string"
}

Remove emergency playlist

Removes emergency playlist of a playout.

path Parameters
playoutId
required
string

Playout id

query Parameters
organizationId
required
string

Responses

Response samples

Content type
application/json
{ }

Get emergency playlist

Returns emergency playlist of a playout.

path Parameters
playoutId
required
string

Playout id

query Parameters
organizationId
required
string

Responses

Response samples

Content type
application/json
[
  • {
    }
]

Apply emergency playlist

Applies default channel emergency playlist to a playout. This method should only be used by internal services

path Parameters
playoutId
required
string

Playout id

query Parameters
organizationId
required
string
Request Body schema: application/json
required
Array
assetName
string
duration
integer <int64>
maxExtendedDuration
integer <int64>
orderNumber
integer <int64>
som
integer <int64>
timecodeIn
integer <int64>

Responses

Request samples

Content type
application/json
[
  • {
    }
]

Response samples

Content type
application/json
{ }

Apply emergency template

Applies default channel emergency template to a playout. This method should only be used by internal services

path Parameters
playoutId
required
string

Playout id

query Parameters
organizationId
required
string
Request Body schema: application/json
string

Responses

Request samples

Content type
application/json
"string"

Response samples

Content type
application/json
{ }

Apply graphics project

Applies default channel graphics project to a playout. This method should only be used by internal services

path Parameters
playoutId
required
string

Playout id

query Parameters
organizationId
required
string
Request Body schema: application/json
string

Responses

Request samples

Content type
application/json
"string"

Response samples

Content type
application/json
{ }

Get assigned Playout graphs

path Parameters
playoutId
required
string

Playout id

query Parameters
organization
required
Array of strings
fetchPlayoutStatuses
boolean
Default: false

Whether to fetch graph statuses from playout

Responses

Response samples

Content type
application/json
[
  • {
    }
]

createPlayoutGraph

path Parameters
playoutId
required
string

Playout id

query Parameters
organization
required
Array of strings
providerId
string
overwriteExisting
boolean
Default: false
Request Body schema: application/json
required
dateCreated
string <date-time>
dateUpdated
string <date-time>
Array of objects (Edge)
id
string
Array of objects (GraphLicence)
object
name
string
Array of objects (Node)
object (PlayoutGraphStatus)

PlayoutGraphStatus

playoutId
string
rootId
string
serviceProviderId
string
type
string
Enum: "SOFTLAB" "DIRECTSHOW" "GSTREAMER"
version
integer <int32>

Responses

Request samples

Content type
application/json
{
  • "dateCreated": "2019-08-24T14:15:22Z",
  • "dateUpdated": "2019-08-24T14:15:22Z",
  • "edges": [
    ],
  • "id": "string",
  • "licences": [
    ],
  • "metadata": {
    },
  • "name": "string",
  • "nodes": [
    ],
  • "playoutGraphStatus": {
    },
  • "playoutId": "string",
  • "rootId": "string",
  • "serviceProviderId": "string",
  • "type": "SOFTLAB",
  • "version": 0
}

Response samples

Content type
application/json
{
  • "dateCreated": "2019-08-24T14:15:22Z",
  • "dateUpdated": "2019-08-24T14:15:22Z",
  • "edges": [
    ],
  • "id": "string",
  • "licences": [
    ],
  • "metadata": {
    },
  • "name": "string",
  • "nodes": [
    ],
  • "playoutGraphStatus": {
    },
  • "playoutId": "string",
  • "rootId": "string",
  • "serviceProviderId": "string",
  • "type": "SOFTLAB",
  • "version": 0
}

Get assigned Playout graph licences

path Parameters
playoutId
required
string
query Parameters
organization
required
Array of strings

Responses

Response samples

Content type
application/json
{
  • "property1": [
    ],
  • "property2": [
    ]
}

Delete graph from playout

Deletes graph with given name from playout.

path Parameters
playoutId
required
string

Playout id

graphId
required
string
query Parameters
organization
required
Array of strings

Responses

Response samples

Content type
application/json
{
  • "dateCreated": "2019-08-24T14:15:22Z",
  • "dateUpdated": "2019-08-24T14:15:22Z",
  • "edges": [
    ],
  • "id": "string",
  • "licences": [
    ],
  • "metadata": {
    },
  • "name": "string",
  • "nodes": [
    ],
  • "playoutGraphStatus": {
    },
  • "playoutId": "string",
  • "rootId": "string",
  • "serviceProviderId": "string",
  • "type": "SOFTLAB",
  • "version": 0
}

Get assigned playout graph id

path Parameters
playoutId
required
string

Playout id

graphId
required
string
query Parameters
organization
required
Array of strings

Responses

Response samples

Content type
application/json
{
  • "dateCreated": "2019-08-24T14:15:22Z",
  • "dateUpdated": "2019-08-24T14:15:22Z",
  • "edges": [
    ],
  • "id": "string",
  • "licences": [
    ],
  • "metadata": {
    },
  • "name": "string",
  • "nodes": [
    ],
  • "playoutGraphStatus": {
    },
  • "playoutId": "string",
  • "rootId": "string",
  • "serviceProviderId": "string",
  • "type": "SOFTLAB",
  • "version": 0
}

updatePlayoutGraph

path Parameters
playoutId
required
string

Playout id

graphId
required
string
query Parameters
organization
required
Array of strings
providerId
string
Request Body schema: application/json
required
dateCreated
string <date-time>
dateUpdated
string <date-time>
Array of objects (Edge)
id
string
Array of objects (GraphLicence)
object
name
string
Array of objects (Node)
object (PlayoutGraphStatus)

PlayoutGraphStatus

playoutId
string
rootId
string
serviceProviderId
string
type
string
Enum: "SOFTLAB" "DIRECTSHOW" "GSTREAMER"
version
integer <int32>

Responses

Request samples

Content type
application/json
{
  • "dateCreated": "2019-08-24T14:15:22Z",
  • "dateUpdated": "2019-08-24T14:15:22Z",
  • "edges": [
    ],
  • "id": "string",
  • "licences": [
    ],
  • "metadata": {
    },
  • "name": "string",
  • "nodes": [
    ],
  • "playoutGraphStatus": {
    },
  • "playoutId": "string",
  • "rootId": "string",
  • "serviceProviderId": "string",
  • "type": "SOFTLAB",
  • "version": 0
}

Response samples

Content type
application/json
{
  • "dateCreated": "2019-08-24T14:15:22Z",
  • "dateUpdated": "2019-08-24T14:15:22Z",
  • "edges": [
    ],
  • "id": "string",
  • "licences": [
    ],
  • "metadata": {
    },
  • "name": "string",
  • "nodes": [
    ],
  • "playoutGraphStatus": {
    },
  • "playoutId": "string",
  • "rootId": "string",
  • "serviceProviderId": "string",
  • "type": "SOFTLAB",
  • "version": 0
}

Update playout graph licence mode

Sets new mode for all playout graph licences. Returns graph licence list

path Parameters
playoutId
required
string

Playout id

graphId
required
string
query Parameters
organization
required
Array of strings
Request Body schema: application/json
required
string
Enum: "DEMO" "PROD"

Responses

Request samples

Content type
application/json
"DEMO"

Response samples

Content type
application/json
[
  • {
    }
]

Apply multimedia package

Applies default channel multimedia package to a playout. This method should only be used by internal services

path Parameters
playoutId
required
string

Playout id

query Parameters
organizationId
required
string
Request Body schema: application/json
string

Responses

Request samples

Content type
application/json
"string"

Response samples

Content type
application/json
{ }

Apply playout permanent graphics

Apply playout permanent graphics

path Parameters
playoutId
required
string

Playout id

query Parameters
organizationId
required
string
Request Body schema: application/json
required
Array
Array of objects (Condition)
elementName
string

Responses

Request samples

Content type
application/json
[
  • {
    }
]

Response samples

Content type
application/json
{ }

Get placeholder playlist

Returns placeholder playlist of a playout.

path Parameters
playoutId
required
string

Playout id

query Parameters
organizationId
required
string

Responses

Response samples

Content type
application/json
[
  • {
    }
]

Apply placeholder playlist

Applies default channel placeholder playlists to a playout. This method should only be used by internal services

path Parameters
playoutId
required
string

Playout id

query Parameters
organizationId
required
string
Request Body schema: application/json
required
Array
Array of objects
name
string
playlistId
integer <int64>
id
string
playoutId
string

Responses

Request samples

Content type
application/json
[
  • {
    }
]

Response samples

Content type
application/json
{ }

Get playout renderer configuration

path Parameters
playoutId
required
string

Playout id

query Parameters
organizationId
required
string

Responses

Response samples

Content type
application/json
{
  • "aspect-ratio": 0,
  • "audio": [
    ],
  • "board-index": 0,
  • "board-name": "string",
  • "frame-rate": 0.1,
  • "licenseId": 0,
  • "resolution-height": 0,
  • "resolution-width": 0,
  • "scan-type": 0,
  • "subtitles": [
    ]
}

Update playout renderer configuration

path Parameters
playoutId
required
string

Playout id

query Parameters
organizationId
required
string
apiVersion
integer <int32>
Default: 1
Request Body schema: application/json
required
aspect-ratio
integer <int32>
Array of objects (RendererAudioConfig)
board-index
integer <int32>
board-name
string
frame-rate
number <double>
licenseId
integer <int32>
resolution-height
integer <int32>
resolution-width
integer <int32>
scan-type
integer <int32>
Array of objects (RendererSubtitleConfig)
object

Responses

Request samples

Content type
application/json
{
  • "aspect-ratio": 0,
  • "audio": [
    ],
  • "board-index": 0,
  • "board-name": "string",
  • "frame-rate": 0.1,
  • "licenseId": 0,
  • "resolution-height": 0,
  • "resolution-width": 0,
  • "scan-type": 0,
  • "subtitles": [
    ],
  • "unknownProperties": {
    }
}

Response samples

Content type
application/json
{
  • "aspect-ratio": 0,
  • "audio": [
    ],
  • "board-index": 0,
  • "board-name": "string",
  • "frame-rate": 0.1,
  • "licenseId": 0,
  • "resolution-height": 0,
  • "resolution-width": 0,
  • "scan-type": 0,
  • "subtitles": [
    ]
}

Reset playout instance

Reset playout instance config

path Parameters
playoutId
required
string

Updated playout object

query Parameters
organization
required
Array of strings
providerId
string
apiVersion
integer <int32>
Default: 1

Responses

Response samples

Content type
application/json
{
  • "adInsertionConfigurations": [],
  • "assetExpireHours": 0,
  • "authToken": "string",
  • "automaticSwitching": {
    },
  • "avmonSettings": {
    },
  • "backup": true,
  • "backupSettings": {
    },
  • "backupType": "HOT",
  • "bandwidthLimit": 1,
  • "cacheLength": "string",
  • "caching": true,
  • "closedCaptionsPassthrough": true,
  • "complianceRecordingSettings": {
    },
  • "concurrentDownloads": 0,
  • "configuration": {
    },
  • "dateCreated": "2019-08-24T14:15:22Z",
  • "dateUpdated": "2019-08-24T14:15:22Z",
  • "deploymentInfo": {
    },
  • "emergencyTemplate": "string",
  • "enabled": true,
  • "fps": 0.1,
  • "graphicsProject": "string",
  • "graphicsProjectV2": "string",
  • "hardwareId": "string",
  • "id": "string",
  • "ignoreTimecode": true,
  • "instanceInfo": {
    },
  • "instanceType": "AWS",
  • "internal": true,
  • "ip": "string",
  • "licenseId": 0,
  • "liveInputs": [
    ],
  • "localCacheId": "string",
  • "localPlayoutId": "string",
  • "mjpegSettings": {
    },
  • "mode": "DEMO",
  • "multimediaPackage": "string",
  • "name": "string",
  • "organizationId": "string",
  • "outputs": [
    ],
  • "password": "string",
  • "port": 0,
  • "presetId": "string",
  • "previewV2Enabled": true,
  • "pushNotificationEnabled": true,
  • "rendererConfiguration": {
    },
  • "scteListenerStrategy": "IGNORE",
  • "serviceProviderId": "string",
  • "statusConfiguration": {
    },
  • "timeBarSettings": {
    },
  • "type": "SD",
  • "uploadBandwidthLimit": 1,
  • "username": "string",
  • "version": 0,
  • "zixiEnabled": true
}

Mark playout instance as stopped

Mark playout instance as stopped

path Parameters
playoutId
required
string
query Parameters
organization
Array of strings
providerId
string
apiVersion
integer <int32>
Default: 1

Responses

Response samples

Content type
application/json
{
  • "adInsertionConfigurations": [],
  • "assetExpireHours": 0,
  • "authToken": "string",
  • "automaticSwitching": {
    },
  • "avmonSettings": {
    },
  • "backup": true,
  • "backupSettings": {
    },
  • "backupType": "HOT",
  • "bandwidthLimit": 1,
  • "cacheLength": "string",
  • "caching": true,
  • "closedCaptionsPassthrough": true,
  • "complianceRecordingSettings": {
    },
  • "concurrentDownloads": 0,
  • "configuration": {
    },
  • "dateCreated": "2019-08-24T14:15:22Z",
  • "dateUpdated": "2019-08-24T14:15:22Z",
  • "deploymentInfo": {
    },
  • "emergencyTemplate": "string",
  • "enabled": true,
  • "fps": 0.1,
  • "graphicsProject": "string",
  • "graphicsProjectV2": "string",
  • "hardwareId": "string",
  • "id": "string",
  • "ignoreTimecode": true,
  • "instanceInfo": {
    },
  • "instanceType": "AWS",
  • "internal": true,
  • "ip": "string",
  • "licenseId": 0,
  • "liveInputs": [
    ],
  • "localCacheId": "string",
  • "localPlayoutId": "string",
  • "mjpegSettings": {
    },
  • "mode": "DEMO",
  • "multimediaPackage": "string",
  • "name": "string",
  • "organizationId": "string",
  • "outputs": [
    ],
  • "password": "string",
  • "port": 0,
  • "presetId": "string",
  • "previewV2Enabled": true,
  • "pushNotificationEnabled": true,
  • "rendererConfiguration": {
    },
  • "scteListenerStrategy": "IGNORE",
  • "serviceProviderId": "string",
  • "statusConfiguration": {
    },
  • "timeBarSettings": {
    },
  • "type": "SD",
  • "uploadBandwidthLimit": 1,
  • "username": "string",
  • "version": 0,
  • "zixiEnabled": true
}

Start playout instance

Start playout instance

path Parameters
playoutId
required
string

Updated playout object

query Parameters
organization
required
Array of strings
providerId
string

Responses

Response samples

Content type
application/json
{
  • "dateCreated": "2019-08-24T14:15:22Z",
  • "dateFinished": "2019-08-24T14:15:22Z",
  • "entityId": "string",
  • "fileName": "string",
  • "id": "string",
  • "jobType": "string",
  • "messages": [
    ],
  • "organization": "string",
  • "resourceExtension": "string",
  • "resourceLink": "string",
  • "serviceProviderId": "string",
  • "status": "PENDING",
  • "uniqueId": "string",
  • "userId": "string"
}

Stop playout instance

Stop playout instance

path Parameters
playoutId
required
string

Updated playout object

query Parameters
silentStop
boolean
Default: false
organization
required
Array of strings
providerId
string

Responses

Response samples

Content type
application/json
{
  • "dateCreated": "2019-08-24T14:15:22Z",
  • "dateFinished": "2019-08-24T14:15:22Z",
  • "entityId": "string",
  • "fileName": "string",
  • "id": "string",
  • "jobType": "string",
  • "messages": [
    ],
  • "organization": "string",
  • "resourceExtension": "string",
  • "resourceLink": "string",
  • "serviceProviderId": "string",
  • "status": "PENDING",
  • "uniqueId": "string",
  • "userId": "string"
}

Un-assign playout from organization

Assign playout to organization by Id

path Parameters
playoutId
required
string

Playout id

query Parameters
providerId
string
apiVersion
integer <int32>
Default: 1

Responses

Response samples

Content type
application/json
{
  • "adInsertionConfigurations": [],
  • "assetExpireHours": 0,
  • "authToken": "string",
  • "automaticSwitching": {
    },
  • "avmonSettings": {
    },
  • "backup": true,
  • "backupSettings": {
    },
  • "backupType": "HOT",
  • "bandwidthLimit": 1,
  • "cacheLength": "string",
  • "caching": true,
  • "closedCaptionsPassthrough": true,
  • "complianceRecordingSettings": {
    },
  • "concurrentDownloads": 0,
  • "configuration": {
    },
  • "dateCreated": "2019-08-24T14:15:22Z",
  • "dateUpdated": "2019-08-24T14:15:22Z",
  • "deploymentInfo": {
    },
  • "emergencyTemplate": "string",
  • "enabled": true,
  • "fps": 0.1,
  • "graphicsProject": "string",
  • "graphicsProjectV2": "string",
  • "hardwareId": "string",
  • "id": "string",
  • "ignoreTimecode": true,
  • "instanceInfo": {
    },
  • "instanceType": "AWS",
  • "internal": true,
  • "ip": "string",
  • "licenseId": 0,
  • "liveInputs": [
    ],
  • "localCacheId": "string",
  • "localPlayoutId": "string",
  • "mjpegSettings": {
    },
  • "mode": "DEMO",
  • "multimediaPackage": "string",
  • "name": "string",
  • "organizationId": "string",
  • "outputs": [
    ],
  • "password": "string",
  • "port": 0,
  • "presetId": "string",
  • "previewV2Enabled": true,
  • "pushNotificationEnabled": true,
  • "rendererConfiguration": {
    },
  • "scteListenerStrategy": "IGNORE",
  • "serviceProviderId": "string",
  • "statusConfiguration": {
    },
  • "timeBarSettings": {
    },
  • "type": "SD",
  • "uploadBandwidthLimit": 1,
  • "username": "string",
  • "version": 0,
  • "zixiEnabled": true
}

Apply graphics project V2

Applies default channel graphics project to a playout. This method should only be used by internal services

path Parameters
playoutId
required
string

Playout id

query Parameters
organizationId
required
string
Request Body schema: application/json
string

Responses

Request samples

Content type
application/json
"string"

Response samples

Content type
application/json
{ }

Jobs

Jobs API

Find jobs

Returns list of jobs by specified search parameters

query Parameters
organization
Array of strings

Organization Id

providerId
string

Service provider Id

finished
boolean

Job finished or not

type
string

Job type (ASSET_CSV|GP_CSV|MCP_CSV|ASSET_QC_REFRESH)

status
string

Job status list

userId
string

Job user name

Responses

Response samples

Content type
application/json
[
  • {
    }
]

Find job by id

Returns job by specified id

path Parameters
jobId
required
string

Job id

query Parameters
organization
Array of strings

Organization Id

Responses

Response samples

Content type
application/json
{
  • "dateCreated": "2019-08-24T14:15:22Z",
  • "dateFinished": "2019-08-24T14:15:22Z",
  • "entityId": "string",
  • "fileName": "string",
  • "id": "string",
  • "jobType": "string",
  • "messages": [
    ],
  • "organization": "string",
  • "resourceExtension": "string",
  • "resourceLink": "string",
  • "serviceProviderId": "string",
  • "status": "PENDING",
  • "uniqueId": "string",
  • "userId": "string"
}

Organization resource

Organization resource

Get organizations

Returns organizations

query Parameters
providerId
string

Service Provider Id

Responses

Response samples

Content type
application/json
[
  • {
    }
]

Create organization configuration

Creates organization configuration

Request Body schema: application/json
required
Array of objects (OrganizationCloudConfiguration) unique
object (ComplianceRecordingSettings)

New compliance recording object

dateCreated
string <date-time>
dateUpdated
string <date-time>
enabled
boolean
id
string
object (Ingest)

Ingest

object (MediaStoreInfo)

New media store object

name
string
object (ResourceLimitsDTO)

New resource limits

serviceProviderId
string
object (OrganizationSettingsDTO)

New settings

Responses

Request samples

Content type
application/json
{
  • "cloudConfigurations": [
    ],
  • "complianceRecordingSettings": {
    },
  • "dateCreated": "2019-08-24T14:15:22Z",
  • "dateUpdated": "2019-08-24T14:15:22Z",
  • "enabled": true,
  • "id": "string",
  • "ingest": {
    },
  • "mediaStoreInfo": {
    },
  • "name": "string",
  • "resourceLimits": {
    },
  • "serviceProviderId": "string",
  • "settings": {
    }
}

Response samples

Content type
application/json
{
  • "code": 0,
  • "messages": [
    ]
}

Request-Response off

Request-Response off

Responses

Response samples

Content type
application/json
{
  • "code": 0,
  • "messages": [
    ]
}

Request-Response on

Request-Response on

Responses

Response samples

Content type
application/json
{
  • "code": 0,
  • "messages": [
    ]
}

Retrieve allowed mediaStoreTypes by service provider ID

query Parameters
providerId
string

Responses

Response samples

Content type
application/json
{
  • "property1": [
    ],
  • "property2": [
    ]
}

Get service providers and their organization

Returns map of service providers and their organization

Responses

Response samples

Content type
application/json
{
  • "property1": "string",
  • "property2": "string"
}

Get complete organization library cleanup configuration

Returns complete organization library cleanup configuration

query Parameters
libraryCleanupEnabled
required
boolean

Responses

Response samples

Content type
application/json
{
  • "property1": {
    },
  • "property2": {
    }
}

Get organization

Returns organization found by Id

path Parameters
organizationId
required
string

Organization id

Responses

Response samples

Content type
application/json
{
  • "cloudConfigurations": [
    ],
  • "complianceRecordingSettings": {
    },
  • "dateCreated": "2019-08-24T14:15:22Z",
  • "dateUpdated": "2019-08-24T14:15:22Z",
  • "enabled": true,
  • "id": "string",
  • "ingest": {
    },
  • "mediaStoreInfo": {
    },
  • "name": "string",
  • "resourceLimits": {
    },
  • "serviceProviderId": "string",
  • "settings": {
    }
}

Get organization block categories

Returns block categories used by organization

path Parameters
organizationId
required
string

Organization id

query Parameters
sort
required
string

Properties that should be sorted by in the format property,property(,ASC|DESC). Default sort direction is ascending. Use multiple sort parameters if you want to switch directions, e.g. ?sort=firstname&sort=lastname,asc

Responses

Response samples

Content type
application/json
[
  • {
    }
]

Create organization block category

Returns block categories used by organization

path Parameters
organizationId
required
string

Organization id

Request Body schema: application/json
required
color
required
string^#([A-Fa-f0-9]{6}|[A-Fa-f0-9]{3})$
dateCreated
string <date-time>
dateUpdated
string <date-time>
id
string
name
required
string
organizationId
string
serviceProviderId
string

Responses

Request samples

Content type
application/json
{
  • "color": "string",
  • "dateCreated": "2019-08-24T14:15:22Z",
  • "dateUpdated": "2019-08-24T14:15:22Z",
  • "id": "string",
  • "name": "string",
  • "organizationId": "string",
  • "serviceProviderId": "string"
}

Response samples

Content type
application/json
{
  • "color": "string",
  • "dateCreated": "2019-08-24T14:15:22Z",
  • "dateUpdated": "2019-08-24T14:15:22Z",
  • "id": "string",
  • "name": "string",
  • "organizationId": "string",
  • "serviceProviderId": "string"
}

Delete organization tag

path Parameters
organizationId
required
string

Organization id

blockCategoryId
required
string

Category id

query Parameters
ignoreUsage
boolean

Ignore category usage in a block

Responses

Response samples

Content type
application/json
{ }

Get organization block category

Returns block category

path Parameters
organizationId
required
string

Organization id

blockCategoryId
required
string

Category id

Responses

Response samples

Content type
application/json
{
  • "color": "string",
  • "dateCreated": "2019-08-24T14:15:22Z",
  • "dateUpdated": "2019-08-24T14:15:22Z",
  • "id": "string",
  • "name": "string",
  • "organizationId": "string",
  • "serviceProviderId": "string"
}

Updates organization block category

path Parameters
organizationId
required
string

Organization id

blockCategoryId
required
string

Category id

Request Body schema: application/json
required
color
required
string^#([A-Fa-f0-9]{6}|[A-Fa-f0-9]{3})$
dateCreated
string <date-time>
dateUpdated
string <date-time>
id
string
name
required
string
organizationId
string
serviceProviderId
string

Responses

Request samples

Content type
application/json
{
  • "color": "string",
  • "dateCreated": "2019-08-24T14:15:22Z",
  • "dateUpdated": "2019-08-24T14:15:22Z",
  • "id": "string",
  • "name": "string",
  • "organizationId": "string",
  • "serviceProviderId": "string"
}

Response samples

Content type
application/json
{
  • "color": "string",
  • "dateCreated": "2019-08-24T14:15:22Z",
  • "dateUpdated": "2019-08-24T14:15:22Z",
  • "id": "string",
  • "name": "string",
  • "organizationId": "string",
  • "serviceProviderId": "string"
}

Get organization cluster token

Returns token to manage edge playouts

path Parameters
organizationId
required
string
query Parameters
providerId
string

Responses

Response samples

Content type
application/json
{
  • "token": "string"
}

Get organization compliance recording config

path Parameters
organizationId
required
string

Organization id

Responses

Response samples

Content type
application/json
{
  • "enabled": true,
  • "externalUploadDestinations": [
    ],
  • "internalUploadEnabled": true,
  • "organizationId": "string",
  • "serviceProviderId": "string"
}

Update organization compliance recording settings

path Parameters
organizationId
required
string

Organization id

Request Body schema: application/json
required
enabled
boolean
Array of objects (UploadDestination) unique
internalUploadEnabled
boolean
organizationId
string
serviceProviderId
string

Responses

Request samples

Content type
application/json
{
  • "enabled": true,
  • "externalUploadDestinations": [
    ],
  • "internalUploadEnabled": true,
  • "organizationId": "string",
  • "serviceProviderId": "string"
}

Response samples

Content type
application/json
{
  • "enabled": true,
  • "externalUploadDestinations": [
    ],
  • "internalUploadEnabled": true,
  • "organizationId": "string",
  • "serviceProviderId": "string"
}

Get organization custom metadata fields

Returns custom metadata fields by organization

path Parameters
organizationId
required
string

Organization id

Responses

Response samples

Content type
application/json
[
  • {
    }
]

Create organization custom metadata field

Returns custom metadata fields in organization

path Parameters
organizationId
required
string

Organization id

Request Body schema: application/json
required
name
string
serviceProviderId
string
title
string

Responses

Request samples

Content type
application/json
{
  • "name": "string",
  • "serviceProviderId": "string",
  • "title": "string"
}

Response samples

Content type
application/json
{
  • "name": "string",
  • "serviceProviderId": "string",
  • "title": "string"
}

Delete organization custom metadata field

path Parameters
organizationId
required
string

Organization id

name
required
string

Responses

Response samples

Content type
application/json
{ }

Get organization custom metadata field

Returns custom metadata field by organization and name

path Parameters
organizationId
required
string

Organization id

name
required
string

Field name

Responses

Response samples

Content type
application/json
{
  • "name": "string",
  • "serviceProviderId": "string",
  • "title": "string"
}

Edit organization custom metadata field

path Parameters
organizationId
required
string

Organization id

name
required
string
Request Body schema: application/json
required
name
string
title
string

Responses

Request samples

Content type
application/json
{
  • "name": "string",
  • "title": "string"
}

Response samples

Content type
application/json
{
  • "name": "string",
  • "serviceProviderId": "string",
  • "title": "string"
}

Disable organization

path Parameters
organizationId
required
string

Organization id

Responses

Response samples

Content type
application/json
{ }

Enable organization

path Parameters
organizationId
required
string

Organization id

Responses

Response samples

Content type
application/json
{ }

Get organization ingest

Returns ingest related configuration for organization

path Parameters
organizationId
required
string

Organization id

Responses

Response samples

Content type
application/json
{
  • "sources": [
    ]
}

Get graphics upload ingest source

Returns ingest source configuration for graphics upload

path Parameters
organizationId
required
string

Organization id

Responses

Response samples

Content type
application/json
{
  • "accessKey": "string",
  • "cirrusSource": true,
  • "containerName": "string",
  • "dateCreated": "2019-08-24T14:15:22Z",
  • "dateUpdated": "2019-08-24T14:15:22Z",
  • "emptyAssetsSource": true,
  • "enabled": true,
  • "expiration": "2019-08-24T14:15:22Z",
  • "graphicsUploadSource": true,
  • "host": "string",
  • "id": "string",
  • "internal": true,
  • "manualListing": true,
  • "musicKitIntegration": true,
  • "name": "string",
  • "nullifySubtitleTimecode": true,
  • "passwordChanged": true,
  • "pollingFrequency": 0,
  • "port": 0,
  • "priority": 0,
  • "privateKey": "string",
  • "privateKeyChanged": true,
  • "properties": {
    },
  • "readOnly": true,
  • "region": "string",
  • "scanOnly": true,
  • "scheduleAutoApplyEnabled": true,
  • "scheduleFileMask": "string",
  • "scheduleTransformationScriptId": "string",
  • "scheduledMissingOnly": true,
  • "secretKey": "string",
  • "secretKeyChanged": true,
  • "serviceProviderId": "string",
  • "sideCarFileMask": "string",
  • "sideCarXmlTransformationScriptId": "string",
  • "sourcePassword": "string",
  • "sourcePath": "string",
  • "sourceUserName": "string",
  • "status": {
    },
  • "storefrontRegion": "string",
  • "subtitleEncoding": "string",
  • "subtitleTimecodeOffset": "string",
  • "tags": [
    ],
  • "timecodeIn": 0,
  • "type": "FTP",
  • "videoConversionEnabled": true,
  • "videoConversionExtensions": [
    ]
}

Get organization ingest qc rules

Returns ingest related configuration for organization

path Parameters
organizationId
required
string

Organization id

Responses

Response samples

Content type
application/json
[
  • {
    }
]

Create organization ingest qc rules

Create ingest qc rule

path Parameters
organizationId
required
string

Organization id

Request Body schema: application/json
required
allowEmpty
boolean
critical
boolean
mediaType
string
Enum: "VIDEO" "AUDIO" "SUBTITLE" "IMAGE" "AE_TEMPLATE" "GRAPHICS_PROJECT" "MULTI_MEDIA_CAPTION_PACKAGE" "SIDE_CAR_XML" "SCHEDULE" "COMPLIANCE_RECORDING" "UNKNOWN" "THUMBNAIL_IMAGE" "THUMBNAIL_VIDEO" "FONT"
operand
string
property
string
resultMessage
string
ruleId
string
object
targetValue
string
targetValueType
string
Enum: "FILE" "VIDEO_STREAM" "AUDIO_STREAM" "TEXT_STREAM" "AUDIO_LOUDNESS" "CUSTOM_DATA" "MEDIA"
validatorType
string
Enum: "VALUE" "LENGTH" "LANGUAGE_CODE" "LIST" "TIME_CODE" "ADAM_ID"
dateCreated
string <date-time>

Date when rule was created

dateUpdated
string <date-time>

Date when rule was updated

id
string

Rule ID

modifiable
boolean

Is rule modifiable

organizationId
string

Organization ID

serviceProviderId
string

Responses

Request samples

Content type
application/json
{
  • "allowEmpty": false,
  • "critical": false,
  • "mediaType": "AUDIO",
  • "modifiable": true,
  • "operand": "<",
  • "property": "duration",
  • "resultMessage": "test",
  • "ruleId": "test",
  • "sourceCondition": { },
  • "targetValue": "3",
  • "targetValueType": "AUDIO_STREAM",
  • "validatorType": "VALUE"
}

Response samples

Content type
application/json
{
  • "allowEmpty": false,
  • "critical": false,
  • "mediaType": "AUDIO",
  • "modifiable": true,
  • "operand": "<",
  • "property": "duration",
  • "resultMessage": "test",
  • "ruleId": "test",
  • "sourceCondition": { },
  • "targetValue": "3",
  • "targetValueType": "AUDIO_STREAM",
  • "validatorType": "VALUE"
}

Delete organization ingest qc rule

Delete ingest related configuration

path Parameters
organizationId
required
string

Organization id

ruleId
required
string

Responses

Response samples

Content type
application/json
{ }

Get organization ingest qc rules

Returns ingest related configuration for organization

path Parameters
organizationId
required
string

Organization id

ruleId
required
string

Responses

Response samples

Content type
application/json
{
  • "allowEmpty": false,
  • "critical": false,
  • "mediaType": "AUDIO",
  • "modifiable": true,
  • "operand": "<",
  • "property": "duration",
  • "resultMessage": "test",
  • "ruleId": "test",
  • "sourceCondition": { },
  • "targetValue": "3",
  • "targetValueType": "AUDIO_STREAM",
  • "validatorType": "VALUE"
}

Update organization ingest qc rules

Returns ingest related configuration for organization

path Parameters
organizationId
required
string

Organization id

ruleId
required
string
Request Body schema: application/json
required
allowEmpty
boolean
critical
boolean
mediaType
string
Enum: "VIDEO" "AUDIO" "SUBTITLE" "IMAGE" "AE_TEMPLATE" "GRAPHICS_PROJECT" "MULTI_MEDIA_CAPTION_PACKAGE" "SIDE_CAR_XML" "SCHEDULE" "COMPLIANCE_RECORDING" "UNKNOWN" "THUMBNAIL_IMAGE" "THUMBNAIL_VIDEO" "FONT"
operand
string
property
string
resultMessage
string
ruleId
string
object
targetValue
string
targetValueType
string
Enum: "FILE" "VIDEO_STREAM" "AUDIO_STREAM" "TEXT_STREAM" "AUDIO_LOUDNESS" "CUSTOM_DATA" "MEDIA"
validatorType
string
Enum: "VALUE" "LENGTH" "LANGUAGE_CODE" "LIST" "TIME_CODE" "ADAM_ID"
dateCreated
string <date-time>

Date when rule was created

dateUpdated
string <date-time>

Date when rule was updated

id
string

Rule ID

modifiable
boolean

Is rule modifiable

organizationId
string

Organization ID

serviceProviderId
string

Responses

Request samples

Content type
application/json
{
  • "allowEmpty": false,
  • "critical": false,
  • "mediaType": "AUDIO",
  • "modifiable": true,
  • "operand": "<",
  • "property": "duration",
  • "resultMessage": "test",
  • "ruleId": "test",
  • "sourceCondition": { },
  • "targetValue": "3",
  • "targetValueType": "AUDIO_STREAM",
  • "validatorType": "VALUE"
}

Response samples

Content type
application/json
{
  • "allowEmpty": false,
  • "critical": false,
  • "mediaType": "AUDIO",
  • "modifiable": true,
  • "operand": "<",
  • "property": "duration",
  • "resultMessage": "test",
  • "ruleId": "test",
  • "sourceCondition": { },
  • "targetValue": "3",
  • "targetValueType": "AUDIO_STREAM",
  • "validatorType": "VALUE"
}

Get organization ingest sources

Returns ingest sources configuration for organization

path Parameters
organizationId
required
string

Organization id

Responses

Response samples

Content type
application/json
[
  • {
    }
]

Create organization ingest source

path Parameters
organizationId
required
string

Organization id

Request Body schema: application/json
required
accessKey
string
cirrusSource
boolean
containerName
string
dateCreated
string <date-time>
dateUpdated
string <date-time>
emptyAssetsSource
boolean
enabled
boolean
expiration
string <date-time>
graphicsUploadSource
boolean
host
string
id
string
internal
boolean
manualListing
boolean
musicKitIntegration
boolean
name
string
nullifySubtitleTimecode
boolean
passwordChanged
boolean
pollingFrequency
integer <int64>
port
integer <int32>
priority
integer <int32>
privateKey
string
privateKeyChanged
boolean
object
readOnly
boolean
region
string
scanOnly
boolean
scheduleAutoApplyEnabled
boolean
scheduleFileMask
string
scheduleTransformationScriptId
string
scheduledMissingOnly
boolean
secretKey
string
secretKeyChanged
boolean
serviceProviderId
string
sideCarFileMask
string
sideCarXmlTransformationScriptId
string
sourcePassword
string
sourcePath
string
sourceUserName
string
storefrontRegion
string
subtitleEncoding
string
subtitleTimecodeOffset
string
Array of objects (Tag) unique
timecodeIn
integer <int64>
type
required
string
Enum: "FTP" "S3" "S3_PAIRED" "SFTP" "TELIA_S3" "ALIBABA" "AZURE" "S3_GENERIC" "DOT_STUDIO"
videoConversionEnabled
boolean
videoConversionExtensions
Array of strings unique

Responses

Request samples

Content type
application/json
{
  • "accessKey": "string",
  • "cirrusSource": true,
  • "containerName": "string",
  • "dateCreated": "2019-08-24T14:15:22Z",
  • "dateUpdated": "2019-08-24T14:15:22Z",
  • "emptyAssetsSource": true,
  • "enabled": true,
  • "expiration": "2019-08-24T14:15:22Z",
  • "graphicsUploadSource": true,
  • "host": "string",
  • "id": "string",
  • "internal": true,
  • "manualListing": true,
  • "musicKitIntegration": true,
  • "name": "string",
  • "nullifySubtitleTimecode": true,
  • "passwordChanged": true,
  • "pollingFrequency": 0,
  • "port": 0,
  • "priority": 0,
  • "privateKey": "string",
  • "privateKeyChanged": true,
  • "properties": {
    },
  • "readOnly": true,
  • "region": "string",
  • "scanOnly": true,
  • "scheduleAutoApplyEnabled": true,
  • "scheduleFileMask": "string",
  • "scheduleTransformationScriptId": "string",
  • "scheduledMissingOnly": true,
  • "secretKey": "string",
  • "secretKeyChanged": true,
  • "serviceProviderId": "string",
  • "sideCarFileMask": "string",
  • "sideCarXmlTransformationScriptId": "string",
  • "sourcePassword": "string",
  • "sourcePath": "string",
  • "sourceUserName": "string",
  • "storefrontRegion": "string",
  • "subtitleEncoding": "string",
  • "subtitleTimecodeOffset": "string",
  • "tags": [
    ],
  • "timecodeIn": 0,
  • "type": "FTP",
  • "videoConversionEnabled": true,
  • "videoConversionExtensions": [
    ]
}

Response samples

Content type
application/json
{
  • "accessKey": "string",
  • "cirrusSource": true,
  • "containerName": "string",
  • "dateCreated": "2019-08-24T14:15:22Z",
  • "dateUpdated": "2019-08-24T14:15:22Z",
  • "emptyAssetsSource": true,
  • "enabled": true,
  • "expiration": "2019-08-24T14:15:22Z",
  • "graphicsUploadSource": true,
  • "host": "string",
  • "id": "string",
  • "internal": true,
  • "manualListing": true,
  • "musicKitIntegration": true,
  • "name": "string",
  • "nullifySubtitleTimecode": true,
  • "passwordChanged": true,
  • "pollingFrequency": 0,
  • "port": 0,
  • "priority": 0,
  • "privateKey": "string",
  • "privateKeyChanged": true,
  • "properties": {
    },
  • "readOnly": true,
  • "region": "string",
  • "scanOnly": true,
  • "scheduleAutoApplyEnabled": true,
  • "scheduleFileMask": "string",
  • "scheduleTransformationScriptId": "string",
  • "scheduledMissingOnly": true,
  • "secretKey": "string",
  • "secretKeyChanged": true,
  • "serviceProviderId": "string",
  • "sideCarFileMask": "string",
  • "sideCarXmlTransformationScriptId": "string",
  • "sourcePassword": "string",
  • "sourcePath": "string",
  • "sourceUserName": "string",
  • "status": {
    },
  • "storefrontRegion": "string",
  • "subtitleEncoding": "string",
  • "subtitleTimecodeOffset": "string",
  • "tags": [
    ],
  • "timecodeIn": 0,
  • "type": "FTP",
  • "videoConversionEnabled": true,
  • "videoConversionExtensions": [
    ]
}

Delete organization ingest source by id

path Parameters
organizationId
required
string

Organization id

sourceId
required
string

Source id

Responses

Response samples

Content type
application/json
{ }

Get organization ingest source by id

Returns organization ingest source configuration

path Parameters
organizationId
required
string

Organization id

sourceId
required
string

Source id

Responses

Response samples

Content type
application/json
{
  • "accessKey": "string",
  • "cirrusSource": true,
  • "containerName": "string",
  • "dateCreated": "2019-08-24T14:15:22Z",
  • "dateUpdated": "2019-08-24T14:15:22Z",
  • "emptyAssetsSource": true,
  • "enabled": true,
  • "expiration": "2019-08-24T14:15:22Z",
  • "graphicsUploadSource": true,
  • "host": "string",
  • "id": "string",
  • "internal": true,
  • "manualListing": true,
  • "musicKitIntegration": true,
  • "name": "string",
  • "nullifySubtitleTimecode": true,
  • "passwordChanged": true,
  • "pollingFrequency": 0,
  • "port": 0,
  • "priority": 0,
  • "privateKey": "string",
  • "privateKeyChanged": true,
  • "properties": {
    },
  • "readOnly": true,
  • "region": "string",
  • "scanOnly": true,
  • "scheduleAutoApplyEnabled": true,
  • "scheduleFileMask": "string",
  • "scheduleTransformationScriptId": "string",
  • "scheduledMissingOnly": true,
  • "secretKey": "string",
  • "secretKeyChanged": true,
  • "serviceProviderId": "string",
  • "sideCarFileMask": "string",
  • "sideCarXmlTransformationScriptId": "string",
  • "sourcePassword": "string",
  • "sourcePath": "string",
  • "sourceUserName": "string",
  • "status": {
    },
  • "storefrontRegion": "string",
  • "subtitleEncoding": "string",
  • "subtitleTimecodeOffset": "string",
  • "tags": [
    ],
  • "timecodeIn": 0,
  • "type": "FTP",
  • "videoConversionEnabled": true,
  • "videoConversionExtensions": [
    ]
}

Update organization ingest source

path Parameters
organizationId
required
string

Organization id

sourceId
required
string

Source id

Request Body schema: application/json
required
accessKey
string
cirrusSource
boolean
containerName
string
dateCreated
string <date-time>
dateUpdated
string <date-time>
emptyAssetsSource
boolean
enabled
boolean
expiration
string <date-time>
graphicsUploadSource
boolean
host
string
id
string
internal
boolean
manualListing
boolean
musicKitIntegration
boolean
name
string
nullifySubtitleTimecode
boolean
passwordChanged
boolean
pollingFrequency
integer <int64>
port
integer <int32>
priority
integer <int32>
privateKey
string
privateKeyChanged
boolean
object
readOnly
boolean
region
string
scanOnly
boolean
scheduleAutoApplyEnabled
boolean
scheduleFileMask
string
scheduleTransformationScriptId
string
scheduledMissingOnly
boolean
secretKey
string
secretKeyChanged
boolean
serviceProviderId
string
sideCarFileMask
string
sideCarXmlTransformationScriptId
string
sourcePassword
string
sourcePath
string
sourceUserName
string
storefrontRegion
string
subtitleEncoding
string
subtitleTimecodeOffset
string
Array of objects (Tag) unique
timecodeIn
integer <int64>
type
required
string
Enum: "FTP" "S3" "S3_PAIRED" "SFTP" "TELIA_S3" "ALIBABA" "AZURE" "S3_GENERIC" "DOT_STUDIO"
videoConversionEnabled
boolean
videoConversionExtensions
Array of strings unique

Responses

Request samples

Content type
application/json
{
  • "accessKey": "string",
  • "cirrusSource": true,
  • "containerName": "string",
  • "dateCreated": "2019-08-24T14:15:22Z",
  • "dateUpdated": "2019-08-24T14:15:22Z",
  • "emptyAssetsSource": true,
  • "enabled": true,
  • "expiration": "2019-08-24T14:15:22Z",
  • "graphicsUploadSource": true,
  • "host": "string",
  • "id": "string",
  • "internal": true,
  • "manualListing": true,
  • "musicKitIntegration": true,
  • "name": "string",
  • "nullifySubtitleTimecode": true,
  • "passwordChanged": true,
  • "pollingFrequency": 0,
  • "port": 0,
  • "priority": 0,
  • "privateKey": "string",
  • "privateKeyChanged": true,
  • "properties": {
    },
  • "readOnly": true,
  • "region": "string",
  • "scanOnly": true,
  • "scheduleAutoApplyEnabled": true,
  • "scheduleFileMask": "string",
  • "scheduleTransformationScriptId": "string",
  • "scheduledMissingOnly": true,
  • "secretKey": "string",
  • "secretKeyChanged": true,
  • "serviceProviderId": "string",
  • "sideCarFileMask": "string",
  • "sideCarXmlTransformationScriptId": "string",
  • "sourcePassword": "string",
  • "sourcePath": "string",
  • "sourceUserName": "string",
  • "storefrontRegion": "string",
  • "subtitleEncoding": "string",
  • "subtitleTimecodeOffset": "string",
  • "tags": [
    ],
  • "timecodeIn": 0,
  • "type": "FTP",
  • "videoConversionEnabled": true,
  • "videoConversionExtensions": [
    ]
}

Response samples

Content type
application/json
{
  • "accessKey": "string",
  • "cirrusSource": true,
  • "containerName": "string",
  • "dateCreated": "2019-08-24T14:15:22Z",
  • "dateUpdated": "2019-08-24T14:15:22Z",
  • "emptyAssetsSource": true,
  • "enabled": true,
  • "expiration": "2019-08-24T14:15:22Z",
  • "graphicsUploadSource": true,
  • "host": "string",
  • "id": "string",
  • "internal": true,
  • "manualListing": true,
  • "musicKitIntegration": true,
  • "name": "string",
  • "nullifySubtitleTimecode": true,
  • "passwordChanged": true,
  • "pollingFrequency": 0,
  • "port": 0,
  • "priority": 0,
  • "privateKey": "string",
  • "privateKeyChanged": true,
  • "properties": {
    },
  • "readOnly": true,
  • "region": "string",
  • "scanOnly": true,
  • "scheduleAutoApplyEnabled": true,
  • "scheduleFileMask": "string",
  • "scheduleTransformationScriptId": "string",
  • "scheduledMissingOnly": true,
  • "secretKey": "string",
  • "secretKeyChanged": true,
  • "serviceProviderId": "string",
  • "sideCarFileMask": "string",
  • "sideCarXmlTransformationScriptId": "string",
  • "sourcePassword": "string",
  • "sourcePath": "string",
  • "sourceUserName": "string",
  • "status": {
    },
  • "storefrontRegion": "string",
  • "subtitleEncoding": "string",
  • "subtitleTimecodeOffset": "string",
  • "tags": [
    ],
  • "timecodeIn": 0,
  • "type": "FTP",
  • "videoConversionEnabled": true,
  • "videoConversionExtensions": [
    ]
}

Get organization live input routes

Returns live input routes

path Parameters
organizationId
required
string
query Parameters
providerId
string

Responses

Response samples

Content type
application/json
[
  • {
    }
]

Create organization live input route

Returns live input routes used by organization

path Parameters
organizationId
required
string
query Parameters
providerId
string
Request Body schema: application/json
required
dateCreated
string <date-time>
dateUpdated
string <date-time>
destinationPlayouts
Array of strings unique

Live route destination playouts

id
string

Live input route id

object (PlayoutLiveInputDTO)
Array of objects (InputAddress) unique
name
string

Live input route name

organizationId
string
serviceProviderId
string

Responses

Request samples

Content type
application/json
{
  • "dateCreated": "2019-08-24T14:15:22Z",
  • "dateUpdated": "2019-08-24T14:15:22Z",
  • "destinationPlayouts": [
    ],
  • "id": "string",
  • "input": {
    },
  • "inputAddresses": [
    ],
  • "name": "string",
  • "organizationId": "string",
  • "serviceProviderId": "string"
}

Response samples

Content type
application/json
{
  • "dateCreated": "2019-08-24T14:15:22Z",
  • "dateUpdated": "2019-08-24T14:15:22Z",
  • "destinationPlayouts": [
    ],
  • "id": "string",
  • "input": {
    },
  • "inputAddresses": [
    ],
  • "name": "string",
  • "organizationId": "string",
  • "serviceProviderId": "string"
}

Delete organization live input route

path Parameters
organizationId
required
string
liveInputRouteId
required
string

Live input route id

query Parameters
providerId
string

Responses

Response samples

Content type
application/json
{
  • "code": 0,
  • "messages": [
    ]
}

Get organization live input route

Returns live input route found by Id

path Parameters
organizationId
required
string
liveInputRouteId
required
string

Live input route id

query Parameters
providerId
string

Responses

Response samples

Content type
application/json
{
  • "dateCreated": "2019-08-24T14:15:22Z",
  • "dateUpdated": "2019-08-24T14:15:22Z",
  • "destinationPlayouts": [
    ],
  • "id": "string",
  • "input": {
    },
  • "inputAddresses": [
    ],
  • "name": "string",
  • "organizationId": "string",
  • "serviceProviderId": "string"
}

Update organization live input route

path Parameters
organizationId
required
string
liveInputRouteId
required
string

Live input route id

query Parameters
providerId
string
Request Body schema: application/json
required
dateCreated
string <date-time>
dateUpdated
string <date-time>
destinationPlayouts
Array of strings unique

Live route destination playouts

id
string

Live input route id

object (PlayoutLiveInputDTO)
Array of objects (InputAddress) unique
name
string

Live input route name

organizationId
string
serviceProviderId
string

Responses

Request samples

Content type
application/json
{
  • "dateCreated": "2019-08-24T14:15:22Z",
  • "dateUpdated": "2019-08-24T14:15:22Z",
  • "destinationPlayouts": [
    ],
  • "id": "string",
  • "input": {
    },
  • "inputAddresses": [
    ],
  • "name": "string",
  • "organizationId": "string",
  • "serviceProviderId": "string"
}

Response samples

Content type
application/json
{
  • "dateCreated": "2019-08-24T14:15:22Z",
  • "dateUpdated": "2019-08-24T14:15:22Z",
  • "destinationPlayouts": [
    ],
  • "id": "string",
  • "input": {
    },
  • "inputAddresses": [
    ],
  • "name": "string",
  • "organizationId": "string",
  • "serviceProviderId": "string"
}

Get organization media store config

Returns media store related configuration for organization

path Parameters
organizationId
required
string

Organization id

Responses

Response samples

Content type
application/json
{
  • "archiveContainerName": "string",
  • "cloudId": "string",
  • "containerName": "string",
  • "containerOwnedByUser": true,
  • "credentials": "string",
  • "identity": "string",
  • "liveRecordingPrefix": "string",
  • "name": "string",
  • "oauthTokenStore": "string",
  • "objectValidityTime": 0,
  • "organizationId": "string",
  • "region": "string",
  • "serviceProviderId": "string",
  • "storeHostName": "string",
  • "storePort": 0,
  • "tenantName": "string",
  • "type": "S3"
}

Update organization media store info

path Parameters
organizationId
required
string

Organization id

Request Body schema: application/json
required
archiveContainerName
string
cloudId
string
containerName
string
containerOwnedByUser
boolean
credentials
string
identity
string
liveRecordingPrefix
string
name
string
oauthTokenStore
string
objectValidityTime
integer <int64>
organizationId
string
region
string
serviceProviderId
string
storeHostName
string
storePort
integer <int32>
tenantName
string
type
string
Enum: "S3" "BRIGHTCOVE" "FTP" "SERVERS_COM" "TELIA_S3" "ALIBABA" "S3_GENERIC" "AZURE" "WASABI" "S3_PAIRED" "S3_EXTERNAL" "DOTSTUDIO_PRO"

Responses

Request samples

Content type
application/json
{
  • "archiveContainerName": "string",
  • "cloudId": "string",
  • "containerName": "string",
  • "containerOwnedByUser": true,
  • "credentials": "string",
  • "identity": "string",
  • "liveRecordingPrefix": "string",
  • "name": "string",
  • "oauthTokenStore": "string",
  • "objectValidityTime": 0,
  • "organizationId": "string",
  • "region": "string",
  • "serviceProviderId": "string",
  • "storeHostName": "string",
  • "storePort": 0,
  • "tenantName": "string",
  • "type": "S3"
}

Response samples

Content type
application/json
{
  • "archiveContainerName": "string",
  • "cloudId": "string",
  • "containerName": "string",
  • "containerOwnedByUser": true,
  • "credentials": "string",
  • "identity": "string",
  • "liveRecordingPrefix": "string",
  • "name": "string",
  • "oauthTokenStore": "string",
  • "objectValidityTime": 0,
  • "organizationId": "string",
  • "region": "string",
  • "serviceProviderId": "string",
  • "storeHostName": "string",
  • "storePort": 0,
  • "tenantName": "string",
  • "type": "S3"
}

Rotate organization media store credentials

path Parameters
organizationId
required
string

Organization id

query Parameters
providerId
string

Service Provider Id

Responses

Response samples

Content type
application/json
{
  • "code": 0,
  • "messages": [
    ]
}

Get playouts for organization

Returns playouts

path Parameters
organizationId
required
string
query Parameters
apiVersion
integer <int32>
Default: 1

Responses

Response samples

Content type
application/json
[
  • {
    }
]

Get playout

Returns playout found by Id

path Parameters
organizationId
required
string
playoutId
required
string

Playout id

query Parameters
apiVersion
integer <int32>
Default: 1

Responses

Response samples

Content type
application/json
{ }

Get organization resource limits

Returns organization resource limits

path Parameters
organizationId
required
string

Organization id

Responses

Response samples

Content type
application/json
{
  • "accountNumber": 0,
  • "channelLimitations": {
    },
  • "dolbyFeaturesEnabled": true,
  • "enableLiveRecording": true,
  • "expirationDate": "2019-08-24T14:15:22Z",
  • "graphicEditorModuleEnabled": true,
  • "ingestQueueItemLimit": 0,
  • "ingestSize": 0,
  • "ingestSources": 0,
  • "legacyIngestSourcesEnabled": true,
  • "liveEnabled": true,
  • "maxCloudPlayouts": 0,
  • "maxConcurrentIngests": 0,
  • "maxWarmBackupUptimeHours": 0,
  • "mediaStoreSize": 0,
  • "planningModuleEnabled": true,
  • "twitchIntegrationEnabled": true,
  • "unlimitedWebrtcSessions": true,
  • "windowsFeaturesEnabled": true
}

Update organization resource limits

path Parameters
organizationId
required
string

Organization id

Request Body schema: application/json
required
accountNumber
integer <int32>
object (ChannelLimitations)
dolbyFeaturesEnabled
boolean
enableLiveRecording
boolean
expirationDate
string <date-time>
graphicEditorModuleEnabled
boolean
ingestQueueItemLimit
integer <int64>
ingestSize
integer <int64>
ingestSources
integer <int32>
legacyIngestSourcesEnabled
boolean
liveEnabled
boolean
maxCloudPlayouts
integer <int32>
maxConcurrentIngests
integer <int32>
maxWarmBackupUptimeHours
integer <int32>
mediaStoreSize
integer <int64>
planningModuleEnabled
boolean
twitchIntegrationEnabled
boolean
unlimitedWebrtcSessions
boolean
windowsFeaturesEnabled
boolean

Responses

Request samples

Content type
application/json
{
  • "accountNumber": 0,
  • "channelLimitations": {
    },
  • "dolbyFeaturesEnabled": true,
  • "enableLiveRecording": true,
  • "expirationDate": "2019-08-24T14:15:22Z",
  • "graphicEditorModuleEnabled": true,
  • "ingestQueueItemLimit": 0,
  • "ingestSize": 0,
  • "ingestSources": 0,
  • "legacyIngestSourcesEnabled": true,
  • "liveEnabled": true,
  • "maxCloudPlayouts": 0,
  • "maxConcurrentIngests": 0,
  • "maxWarmBackupUptimeHours": 0,
  • "mediaStoreSize": 0,
  • "planningModuleEnabled": true,
  • "twitchIntegrationEnabled": true,
  • "unlimitedWebrtcSessions": true,
  • "windowsFeaturesEnabled": true
}

Response samples

Content type
application/json
{ }

Apply default resource limit pack to organization

path Parameters
organizationId
required
string

Organization id

Responses

Response samples

Content type
application/json
{ }

Apply resource limit pack to organization

path Parameters
organizationId
required
string

Organization id

Request Body schema: application/json
required
string

Id of resource limit pack to apply

Responses

Request samples

Content type
application/json
"string"

Response samples

Content type
application/json
{
  • "accountNumber": 0,
  • "daysToExpiration": 0,
  • "id": "string",
  • "ingestSize": 0,
  • "ingestSources": 0,
  • "liveEnabled": true,
  • "maxCloudPlayouts": 0,
  • "maxConcurrentIngests": 1,
  • "mediaStoreSize": 0,
  • "name": "string",
  • "windowsFeaturesEnabled": true
}

Get organization secondary event templates

Returns secondary event templates related configuration for organization

path Parameters
organizationId
required
string

Organization id

Responses

Response samples

Content type
application/json
[
  • {
    }
]

Create organization secondary event template

path Parameters
organizationId
required
string

Organization id

Request Body schema: application/json
required
object (AudioTransitionDTO)
dateCreated
string <date-time>
dateUpdated
string <date-time>
fps
number <float>
graphicsProject
string
graphicsProjectV2
string
id
string
name
required
string
organizationId
string
overrideAudioTransition
boolean
overrideScte35Signals
boolean
overrideSecondaryEvents
boolean
overrideTwitchRPCList
boolean
Array of objects (SCTE35SignalDTO)
Array of objects (SecondaryEventDTO)
serviceProviderId
string
Array of objects (TwitchRPCDTO)

Responses

Request samples

Content type
application/json
{
  • "audioTransition": {
    },
  • "dateCreated": "2019-08-24T14:15:22Z",
  • "dateUpdated": "2019-08-24T14:15:22Z",
  • "fps": 0.1,
  • "graphicsProject": "string",
  • "graphicsProjectV2": "string",
  • "id": "string",
  • "name": "string",
  • "organizationId": "string",
  • "overrideAudioTransition": true,
  • "overrideScte35Signals": true,
  • "overrideSecondaryEvents": true,
  • "overrideTwitchRPCList": true,
  • "scte35Signals": [
    ],
  • "secondaryEvents": [
    ],
  • "serviceProviderId": "string",
  • "twitchRPCList": [
    ]
}

Response samples

Content type
application/json
{
  • "audioTransition": {
    },
  • "dateCreated": "2019-08-24T14:15:22Z",
  • "dateUpdated": "2019-08-24T14:15:22Z",
  • "fps": 0.1,
  • "graphicsProject": "string",
  • "graphicsProjectV2": "string",
  • "id": "string",
  • "name": "string",
  • "organizationId": "string",
  • "overrideAudioTransition": true,
  • "overrideScte35Signals": true,
  • "overrideSecondaryEvents": true,
  • "overrideTwitchRPCList": true,
  • "scte35Signals": [
    ],
  • "secondaryEvents": [
    ],
  • "serviceProviderId": "string",
  • "twitchRPCList": [
    ]
}

Delete organization secondary event template

path Parameters
organizationId
required
string

Organization id

templateId
required
string

Template id

Responses

Response samples

Content type
application/json
{ }

Get organization secondary event template

Returns secondary event template related configuration for organization

path Parameters
organizationId
required
string

Organization id

templateId
required
string

Template id

Responses

Response samples

Content type
application/json
{
  • "audioTransition": {
    },
  • "dateCreated": "2019-08-24T14:15:22Z",
  • "dateUpdated": "2019-08-24T14:15:22Z",
  • "fps": 0.1,
  • "graphicsProject": "string",
  • "graphicsProjectV2": "string",
  • "id": "string",
  • "name": "string",
  • "organizationId": "string",
  • "overrideAudioTransition": true,
  • "overrideScte35Signals": true,
  • "overrideSecondaryEvents": true,
  • "overrideTwitchRPCList": true,
  • "scte35Signals": [
    ],
  • "secondaryEvents": [
    ],
  • "serviceProviderId": "string",
  • "twitchRPCList": [
    ]
}

Update organization secondary event template

path Parameters
organizationId
required
string

Organization id

templateId
required
string

Template id

Request Body schema: application/json
required
object (AudioTransitionDTO)
dateCreated
string <date-time>
dateUpdated
string <date-time>
fps
number <float>
graphicsProject
string
graphicsProjectV2
string
id
string
name
required
string
organizationId
string
overrideAudioTransition
boolean
overrideScte35Signals
boolean
overrideSecondaryEvents
boolean
overrideTwitchRPCList
boolean
Array of objects (SCTE35SignalDTO)
Array of objects (SecondaryEventDTO)
serviceProviderId
string
Array of objects (TwitchRPCDTO)

Responses

Request samples

Content type
application/json
{
  • "audioTransition": {
    },
  • "dateCreated": "2019-08-24T14:15:22Z",
  • "dateUpdated": "2019-08-24T14:15:22Z",
  • "fps": 0.1,
  • "graphicsProject": "string",
  • "graphicsProjectV2": "string",
  • "id": "string",
  • "name": "string",
  • "organizationId": "string",
  • "overrideAudioTransition": true,
  • "overrideScte35Signals": true,
  • "overrideSecondaryEvents": true,
  • "overrideTwitchRPCList": true,
  • "scte35Signals": [
    ],
  • "secondaryEvents": [
    ],
  • "serviceProviderId": "string",
  • "twitchRPCList": [
    ]
}

Response samples

Content type
application/json
{
  • "audioTransition": {
    },
  • "dateCreated": "2019-08-24T14:15:22Z",
  • "dateUpdated": "2019-08-24T14:15:22Z",
  • "fps": 0.1,
  • "graphicsProject": "string",
  • "graphicsProjectV2": "string",
  • "id": "string",
  • "name": "string",
  • "organizationId": "string",
  • "overrideAudioTransition": true,
  • "overrideScte35Signals": true,
  • "overrideSecondaryEvents": true,
  • "overrideTwitchRPCList": true,
  • "scte35Signals": [
    ],
  • "secondaryEvents": [
    ],
  • "serviceProviderId": "string",
  • "twitchRPCList": [
    ]
}

Get organization settings

Returns organization settings

path Parameters
organizationId
required
string

Organization id

Responses

Response samples

Content type
application/json
{
  • "eventAudioFadingConfiguration": {
    },
  • "fps": 0.1,
  • "libraryCleanupConfiguration": {
    },
  • "schedulingTimelineLockDays": 0,
  • "thresholdsConfiguration": {
    },
  • "timeZone": "string",
  • "timeZones": [
    ]
}

Update organization settings

path Parameters
organizationId
required
string

Organization id

Request Body schema: application/json
required
object (EventAudioFadingConfiguration)
fps
number <float>
object (LibraryCleanupConfigurationDTO)

New settings

schedulingTimelineLockDays
integer <int32>
object (ThresholdsConfigurationDTO)

New thresholds

timeZone
string
Array of objects (TimeZoneDTO)

Responses

Request samples

Content type
application/json
{
  • "eventAudioFadingConfiguration": {
    },
  • "fps": 0.1,
  • "libraryCleanupConfiguration": {
    },
  • "schedulingTimelineLockDays": 0,
  • "thresholdsConfiguration": {
    },
  • "timeZone": "string",
  • "timeZones": [
    ]
}

Response samples

Content type
application/json
{
  • "eventAudioFadingConfiguration": {
    },
  • "fps": 0.1,
  • "libraryCleanupConfiguration": {
    },
  • "schedulingTimelineLockDays": 0,
  • "thresholdsConfiguration": {
    },
  • "timeZone": "string",
  • "timeZones": [
    ]
}

Get organization library cleanup configuration

Returns organization library cleanup configuration

path Parameters
organizationId
required
string

Organization id

Responses

Response samples

Content type
application/json
{
  • "daysNotModified": 0,
  • "daysNotScheduled": 0,
  • "libraryCleanupEnabled": true,
  • "type": "REMOVE"
}

Update organization library cleanup configuration

path Parameters
organizationId
required
string

Organization id

Request Body schema: application/json
required
daysNotModified
integer <int32>
daysNotScheduled
integer <int32>
libraryCleanupEnabled
boolean
type
string
Enum: "REMOVE" "ARCHIVE"

Responses

Request samples

Content type
application/json
{
  • "daysNotModified": 0,
  • "daysNotScheduled": 0,
  • "libraryCleanupEnabled": true,
  • "type": "REMOVE"
}

Response samples

Content type
application/json
{
  • "daysNotModified": 0,
  • "daysNotScheduled": 0,
  • "libraryCleanupEnabled": true,
  • "type": "REMOVE"
}

Get shceduling timeline lock days config

Returns scheduling timeline lock days config

path Parameters
organizationId
required
string

Responses

Response samples

Content type
application/json
0
0

Update organization scheduling timeline lock period

path Parameters
organizationId
required
string

Organization id

Request Body schema: application/json
required
integer <int32>

Responses

Request samples

Content type
application/json
0
0

Response samples

Content type
application/json
0
0

Get organization thresholds

Returns organization thresholds

path Parameters
organizationId
required
string

Organization id

Responses

Response samples

Content type
application/json
{
  • "assetThresholds": {
    },
  • "eventThresholds": {
    }
}

Update organization thresholds

path Parameters
organizationId
required
string

Organization id

Request Body schema: application/json
required
object (AssetThresholdsDTO)
object (EventThresholdsDTO)

Responses

Request samples

Content type
application/json
{
  • "assetThresholds": {
    },
  • "eventThresholds": {
    }
}

Response samples

Content type
application/json
{
  • "assetThresholds": {
    },
  • "eventThresholds": {
    }
}

Delete organization tag

path Parameters
organizationId
required
string

Organization id

query Parameters
name
required
string

Responses

Response samples

Content type
application/json
{
  • "code": 0,
  • "messages": [
    ]
}

Get organization tags

Returns tags used by organization

path Parameters
organizationId
required
string

Organization id

Responses

Response samples

Content type
application/json
[
  • {
    }
]

Create organization tags

Returns tags used by organization

path Parameters
organizationId
required
string

Organization id

Request Body schema: application/json
required
Array
name
string
serviceProviderId
string

Responses

Request samples

Content type
application/json
[
  • {
    }
]

Response samples

Content type
application/json
[
  • {
    }
]

Edit organization tag

path Parameters
organizationId
required
string

Organization id

query Parameters
name
required
string
Request Body schema: application/json
required
name
string
serviceProviderId
string

Responses

Request samples

Content type
application/json
{
  • "name": "string",
  • "serviceProviderId": "string"
}

Response samples

Content type
application/json
{
  • "code": 0,
  • "messages": [
    ]
}

Get Org cloud configuration

Returns Org cloud configuration

path Parameters
organization
required
string
query Parameters
providerId
string

Service Provider Id

Responses

Response samples

Content type
application/json
[
  • {
    }
]

Create Org cloud configuration

Returns Org cloud configuration

path Parameters
organization
required
string
query Parameters
type
string
Default: "AWS"
Enum: "AWS" "TELIA" "ALIBABA" "WASABI" "AZURE" "AWS_PAIRED"
providerId
string

Service Provider Id

Request Body schema: application/json
required
accessKey
string
additionalRegions
Array of strings unique
apiKey
string
apiUrl
string
dateCreated
string <date-time>
dateUpdated
string <date-time>
domainKey
string
id
string
object (IngestInstanceConfigurationDTO)
object (MediaStoreSettingsDTO)
organizationId
string
object (PlayoutInstanceSettingsDTO)
providerId
string
region
string
secretKey
string
serviceProviderId
string
type
string
Enum: "AWS" "TELIA" "ALIBABA" "WASABI" "AZURE" "AWS_PAIRED"
Array of objects (VirtualMachineConfigurationDTO)

Responses

Request samples

Content type
application/json
{
  • "accessKey": "string",
  • "additionalRegions": [
    ],
  • "apiKey": "string",
  • "apiUrl": "string",
  • "dateCreated": "2019-08-24T14:15:22Z",
  • "dateUpdated": "2019-08-24T14:15:22Z",
  • "domainKey": "string",
  • "id": "string",
  • "ingestInstanceConfiguration": {
    },
  • "mediaStoreSettings": {
    },
  • "organizationId": "string",
  • "playoutInstanceConfiguration": {
    },
  • "providerId": "string",
  • "region": "string",
  • "secretKey": "string",
  • "serviceProviderId": "string",
  • "type": "AWS",
  • "vmConfigs": [
    ]
}

Response samples

Content type
application/json
{ }

Get Org cloud configuration

Returns Org cloud configuration

path Parameters
organization
required
string
type
required
string
Enum: "AWS" "TELIA" "ALIBABA" "WASABI" "AZURE" "AWS_PAIRED"
query Parameters
providerId
string

Service Provider Id

Responses

Response samples

Content type
application/json
{
  • "accessKey": "string",
  • "additionalRegions": [
    ],
  • "apiKey": "string",
  • "apiUrl": "string",
  • "domainKey": "string",
  • "id": "string",
  • "ingestInstanceConfiguration": {
    },
  • "mediaStoreSettings": {
    },
  • "organizationId": "string",
  • "playoutInstanceConfiguration": {
    },
  • "providerId": "string",
  • "region": "string",
  • "secretKey": "string",
  • "type": "AWS",
  • "vmConfigs": [
    ]
}

Update org cloud config

Returns updated cloud config

path Parameters
organization
required
string
type
required
string
Enum: "AWS" "TELIA" "ALIBABA" "WASABI" "AZURE" "AWS_PAIRED"
query Parameters
providerId
string

Service Provider Id

Request Body schema: application/json
required
accessKey
string
additionalRegions
Array of strings unique
apiKey
string
apiUrl
string
dateCreated
string <date-time>
dateUpdated
string <date-time>
domainKey
string
id
string
object (IngestInstanceConfigurationDTO)
object (MediaStoreSettingsDTO)
organizationId
string
object (PlayoutInstanceSettingsDTO)
providerId
string
region
string
secretKey
string
serviceProviderId
string
type
string
Enum: "AWS" "TELIA" "ALIBABA" "WASABI" "AZURE" "AWS_PAIRED"
Array of objects (VirtualMachineConfigurationDTO)

Responses

Request samples

Content type
application/json
{
  • "accessKey": "string",
  • "additionalRegions": [
    ],
  • "apiKey": "string",
  • "apiUrl": "string",
  • "dateCreated": "2019-08-24T14:15:22Z",
  • "dateUpdated": "2019-08-24T14:15:22Z",
  • "domainKey": "string",
  • "id": "string",
  • "ingestInstanceConfiguration": {
    },
  • "mediaStoreSettings": {
    },
  • "organizationId": "string",
  • "playoutInstanceConfiguration": {
    },
  • "providerId": "string",
  • "region": "string",
  • "secretKey": "string",
  • "serviceProviderId": "string",
  • "type": "AWS",
  • "vmConfigs": [
    ]
}

Response samples

Content type
application/json
{
  • "accessKey": "string",
  • "additionalRegions": [
    ],
  • "apiKey": "string",
  • "apiUrl": "string",
  • "dateCreated": "2019-08-24T14:15:22Z",
  • "dateUpdated": "2019-08-24T14:15:22Z",
  • "domainKey": "string",
  • "id": "string",
  • "ingestInstanceConfiguration": {
    },
  • "mediaStoreSettings": {
    },
  • "organizationId": "string",
  • "playoutInstanceConfiguration": {
    },
  • "providerId": "string",
  • "region": "string",
  • "secretKey": "string",
  • "serviceProviderId": "string",
  • "type": "AWS",
  • "vmConfigs": [
    ]
}

Update org cloud config default region

Returns updated cloud config

path Parameters
organization
required
string
type
required
string
Enum: "AWS" "TELIA" "ALIBABA" "WASABI" "AZURE" "AWS_PAIRED"
query Parameters
providerId
string

Service Provider Id

Request Body schema: application/json
required
string

Responses

Request samples

Content type
application/json
"string"

Response samples

Content type
application/json
{
  • "accessKey": "string",
  • "additionalRegions": [
    ],
  • "apiKey": "string",
  • "apiUrl": "string",
  • "dateCreated": "2019-08-24T14:15:22Z",
  • "dateUpdated": "2019-08-24T14:15:22Z",
  • "domainKey": "string",
  • "id": "string",
  • "ingestInstanceConfiguration": {
    },
  • "mediaStoreSettings": {
    },
  • "organizationId": "string",
  • "playoutInstanceConfiguration": {
    },
  • "providerId": "string",
  • "region": "string",
  • "secretKey": "string",
  • "serviceProviderId": "string",
  • "type": "AWS",
  • "vmConfigs": [
    ]
}

Removes existing region for organization cloud configuration and cleanups cloud resources

Returns Org cloudconfiguration

path Parameters
organization
required
string
type
required
string
Enum: "AWS" "TELIA" "ALIBABA" "WASABI" "AZURE" "AWS_PAIRED"
region
required
string

Responses

Response samples

Content type
application/json
{
  • "accessKey": "string",
  • "additionalRegions": [
    ],
  • "apiKey": "string",
  • "apiUrl": "string",
  • "dateCreated": "2019-08-24T14:15:22Z",
  • "dateUpdated": "2019-08-24T14:15:22Z",
  • "domainKey": "string",
  • "id": "string",
  • "ingestInstanceConfiguration": {
    },
  • "mediaStoreSettings": {
    },
  • "organizationId": "string",
  • "playoutInstanceConfiguration": {
    },
  • "providerId": "string",
  • "region": "string",
  • "secretKey": "string",
  • "serviceProviderId": "string",
  • "type": "AWS",
  • "vmConfigs": [
    ]
}

Initialize new region for organization cloud configuration

Returns Org cloud configuration

path Parameters
organization
required
string
type
required
string
Enum: "AWS" "TELIA" "ALIBABA" "WASABI" "AZURE" "AWS_PAIRED"
region
required
string

Responses

Response samples

Content type
application/json
{
  • "accessKey": "string",
  • "additionalRegions": [
    ],
  • "apiKey": "string",
  • "apiUrl": "string",
  • "dateCreated": "2019-08-24T14:15:22Z",
  • "dateUpdated": "2019-08-24T14:15:22Z",
  • "domainKey": "string",
  • "id": "string",
  • "ingestInstanceConfiguration": {
    },
  • "mediaStoreSettings": {
    },
  • "organizationId": "string",
  • "playoutInstanceConfiguration": {
    },
  • "providerId": "string",
  • "region": "string",
  • "secretKey": "string",
  • "serviceProviderId": "string",
  • "type": "AWS",
  • "vmConfigs": [
    ]
}

Refreshes existing region for organization cloud configuration

Returns Org cloudconfiguration

path Parameters
organization
required
string
type
required
string
Enum: "AWS" "TELIA" "ALIBABA" "WASABI" "AZURE" "AWS_PAIRED"
region
required
string

Responses

Response samples

Content type
application/json
{
  • "accessKey": "string",
  • "additionalRegions": [
    ],
  • "apiKey": "string",
  • "apiUrl": "string",
  • "dateCreated": "2019-08-24T14:15:22Z",
  • "dateUpdated": "2019-08-24T14:15:22Z",
  • "domainKey": "string",
  • "id": "string",
  • "ingestInstanceConfiguration": {
    },
  • "mediaStoreSettings": {
    },
  • "organizationId": "string",
  • "playoutInstanceConfiguration": {
    },
  • "providerId": "string",
  • "region": "string",
  • "secretKey": "string",
  • "serviceProviderId": "string",
  • "type": "AWS",
  • "vmConfigs": [
    ]
}

Migrate to different SP

Returns Org

path Parameters
organization
required
string
query Parameters
providerId
string
apiVersion
integer <int32>
Default: 1
Request Body schema: application/json
required
string

Responses

Request samples

Content type
application/json
"string"

Response samples

Content type
application/json
{
  • "cloudConfigurations": [
    ],
  • "complianceRecordingSettings": {
    },
  • "dateCreated": "2019-08-24T14:15:22Z",
  • "dateUpdated": "2019-08-24T14:15:22Z",
  • "enabled": true,
  • "id": "string",
  • "ingest": {
    },
  • "mediaStoreInfo": {
    },
  • "name": "string",
  • "resourceLimits": {
    },
  • "serviceProviderId": "string",
  • "settings": {
    }
}

Graphs

Graphs API

Get graph templates

Returns graph templates that are available for organization

query Parameters
organization
Array of strings

Organization Id

providerId
string
include
Array of strings
name
string

Search by graph template name

Responses

Response samples

Content type
application/json
[
  • {
    }
]

Create a new graph template

Creates a new graph template

query Parameters
organization
Array of strings

Organization Id

providerId
string
Request Body schema: application/json
required
dateCreated
string <date-time>
dateUpdated
string <date-time>
Array of objects (Edge)
id
string
object
name
string
Array of objects (Node)
organizationId
string
rootId
string
serviceProviderId
string
type
string
Enum: "SOFTLAB" "DIRECTSHOW" "GSTREAMER"
version
integer <int32>

Responses

Request samples

Content type
application/json
{
  • "dateCreated": "2019-08-24T14:15:22Z",
  • "dateUpdated": "2019-08-24T14:15:22Z",
  • "edges": [
    ],
  • "id": "string",
  • "metadata": {
    },
  • "name": "string",
  • "nodes": [
    ],
  • "organizationId": "string",
  • "rootId": "string",
  • "serviceProviderId": "string",
  • "type": "SOFTLAB",
  • "version": 0
}

Response samples

Content type
application/json
{
  • "dateCreated": "2019-08-24T14:15:22Z",
  • "dateUpdated": "2019-08-24T14:15:22Z",
  • "edges": [
    ],
  • "id": "string",
  • "metadata": {
    },
  • "name": "string",
  • "nodes": [
    ],
  • "organizationId": "string",
  • "rootId": "string",
  • "serviceProviderId": "string",
  • "type": "SOFTLAB",
  • "version": 0
}

Download exported graph template file

Returns graph template in json format

path Parameters
fileName
required
string

File name

Responses

Response samples

Content type
application/json
{ }

Import graph template from xml

Creates a new graph template

query Parameters
organization
Array of strings

Organization Id

providerId
string
Request Body schema: application/json
file
required
string <binary>

Responses

Request samples

Content type
application/json
{
  • "file": "string"
}

Response samples

Content type
application/json
{
  • "dateCreated": "2019-08-24T14:15:22Z",
  • "dateUpdated": "2019-08-24T14:15:22Z",
  • "edges": [
    ],
  • "id": "string",
  • "metadata": {
    },
  • "name": "string",
  • "nodes": [
    ],
  • "organizationId": "string",
  • "rootId": "string",
  • "serviceProviderId": "string",
  • "type": "SOFTLAB",
  • "version": 0
}

Delete graph template

Deletes graph template with given ID

path Parameters
graphId
required
string

Graph template Id

query Parameters
organization
Array of strings

Organization Id

providerId
string

Responses

Response samples

Content type
application/json
{ }

Get graph template

Returns graph template with given ID

path Parameters
graphId
required
string

Graph Template Id

query Parameters
organization
Array of strings

Organization Id

providerId
string

Responses

Response samples

Content type
application/json
{
  • "dateCreated": "2019-08-24T14:15:22Z",
  • "dateUpdated": "2019-08-24T14:15:22Z",
  • "edges": [
    ],
  • "id": "string",
  • "metadata": {
    },
  • "name": "string",
  • "nodes": [
    ],
  • "organizationId": "string",
  • "rootId": "string",
  • "serviceProviderId": "string",
  • "type": "SOFTLAB",
  • "version": 0
}

Update graph template

Update the graph template with given ID

path Parameters
graphId
required
string

Graph template Id

query Parameters
organization
Array of strings

Organization Id

providerId
string

Service provider Id

Request Body schema: application/json
required
dateCreated
string <date-time>
dateUpdated
string <date-time>
Array of objects (Edge)
id
string
object
name
string
Array of objects (Node)
organizationId
string
rootId
string
serviceProviderId
string
type
string
Enum: "SOFTLAB" "DIRECTSHOW" "GSTREAMER"
version
integer <int32>

Responses

Request samples

Content type
application/json
{
  • "dateCreated": "2019-08-24T14:15:22Z",
  • "dateUpdated": "2019-08-24T14:15:22Z",
  • "edges": [
    ],
  • "id": "string",
  • "metadata": {
    },
  • "name": "string",
  • "nodes": [
    ],
  • "organizationId": "string",
  • "rootId": "string",
  • "serviceProviderId": "string",
  • "type": "SOFTLAB",
  • "version": 0
}

Response samples

Content type
application/json
{
  • "dateCreated": "2019-08-24T14:15:22Z",
  • "dateUpdated": "2019-08-24T14:15:22Z",
  • "edges": [
    ],
  • "id": "string",
  • "metadata": {
    },
  • "name": "string",
  • "nodes": [
    ],
  • "organizationId": "string",
  • "rootId": "string",
  • "serviceProviderId": "string",
  • "type": "SOFTLAB",
  • "version": 0
}

Export graph template

Exports graph template with given ID

path Parameters
graphId
required
string

Graph template Id

query Parameters
organization
Array of strings

Organization Id

providerId
string

Service provider Id

Responses

Response samples

Content type
application/json
{
  • "dateCreated": "2019-08-24T14:15:22Z",
  • "dateFinished": "2019-08-24T14:15:22Z",
  • "entityId": "string",
  • "fileName": "string",
  • "id": "string",
  • "jobType": "string",
  • "messages": [
    ],
  • "organization": "string",
  • "resourceExtension": "string",
  • "resourceLink": "string",
  • "serviceProviderId": "string",
  • "status": "PENDING",
  • "uniqueId": "string",
  • "userId": "string"
}

internal

Decrypt value

Decrypt value

Request Body schema: application/json
required
string

Responses

Request samples

Content type
application/json
"string"

Response samples

Content type
application/json
"string"

Encrypt value

Encrypt value

Request Body schema: application/json
required
string

Responses

Request samples

Content type
application/json
"string"

Response samples

Content type
application/json
"string"

crypto

Decrypt value

Decrypt value

Request Body schema: application/json
required
string

Responses

Request samples

Content type
application/json
"string"

Response samples

Content type
application/json
"string"

Encrypt value

Encrypt value

Request Body schema: application/json
required
string

Responses

Request samples

Content type
application/json
"string"

Response samples

Content type
application/json
"string"

Ingest cluster resource

Get ingest cluster configurations

Returns ingest cluster configurations

Responses

Response samples

Content type
application/json
[
  • {
    }
]

Create ingest cluster configuration

Returns ingest cluster configuration

Request Body schema: application/json
required
clusterId
required
string
dateCreated
string <date-time>
dateUpdated
string <date-time>
id
string
organizationId
string
organizations
Array of strings unique
regions
Array of strings unique
serviceProviderId
string
serviceProviders
Array of strings unique
storageTypes
Array of strings unique

Responses

Request samples

Content type
application/json
{
  • "clusterId": "string",
  • "dateCreated": "2019-08-24T14:15:22Z",
  • "dateUpdated": "2019-08-24T14:15:22Z",
  • "id": "string",
  • "organizationId": "string",
  • "organizations": [
    ],
  • "regions": [
    ],
  • "serviceProviderId": "string",
  • "serviceProviders": [
    ],
  • "storageTypes": [
    ]
}

Response samples

Content type
application/json
{ }

Delete ingest cluster settings

path Parameters
clusterId
required
string

Responses

Response samples

Content type
application/json
{
  • "code": 0,
  • "messages": [
    ]
}

Get ingest cluster configuration

Returns ingest cluster configuration

path Parameters
clusterId
required
string

Responses

Response samples

Content type
application/json
{
  • "clusterId": "string",
  • "dateCreated": "2019-08-24T14:15:22Z",
  • "dateUpdated": "2019-08-24T14:15:22Z",
  • "id": "string",
  • "organizationId": "string",
  • "organizations": [
    ],
  • "regions": [
    ],
  • "serviceProviderId": "string",
  • "serviceProviders": [
    ],
  • "storageTypes": [
    ]
}

Update ingest cluster settings

Returns updated config

path Parameters
clusterId
required
string
Request Body schema: application/json
required
clusterId
required
string
dateCreated
string <date-time>
dateUpdated
string <date-time>
id
string
organizationId
string
organizations
Array of strings unique
regions
Array of strings unique
serviceProviderId
string
serviceProviders
Array of strings unique
storageTypes
Array of strings unique

Responses

Request samples

Content type
application/json
{
  • "clusterId": "string",
  • "dateCreated": "2019-08-24T14:15:22Z",
  • "dateUpdated": "2019-08-24T14:15:22Z",
  • "id": "string",
  • "organizationId": "string",
  • "organizations": [
    ],
  • "regions": [
    ],
  • "serviceProviderId": "string",
  • "serviceProviders": [
    ],
  • "storageTypes": [
    ]
}

Response samples

Content type
application/json
{
  • "clusterId": "string",
  • "dateCreated": "2019-08-24T14:15:22Z",
  • "dateUpdated": "2019-08-24T14:15:22Z",
  • "id": "string",
  • "organizationId": "string",
  • "organizations": [
    ],
  • "regions": [
    ],
  • "serviceProviderId": "string",
  • "serviceProviders": [
    ],
  • "storageTypes": [
    ]
}

Cloud Instance resource

Find all instance

Find instance

query Parameters
organization
Array of strings

Organization Id

providerId
string

Responses

Response samples

Content type
application/json
[
  • {
    }
]

Create new instance

Creates instance

query Parameters
organization
Array of strings

Organization Id

providerId
string
Request Body schema: application/json
required
armArch
boolean
cdiSupportEnabled
boolean
cloudType
string
Enum: "AWS" "AWS_PAIRED" "TELIA" "ALIBABA" "EDGE" "AZURE"
deploymentType
string
Enum: "DOCKER" "KUBERNETES"
dns
string
experimental
boolean
externalIp
string
externalIpReservationId
string
instanceName
string
instancePort
integer <int32>
instanceType
string
licenseId
string
nixEnabled
boolean
region
string
remoteId
string
reuseIp
boolean
skipInstall
boolean
slots
integer <int32>
sshKey
string
systemPassword
string
systemUser
string
type
string
Enum: "SD" "HD" "UHD"
vmType
string
Enum: "WINDOWS" "LINUX"
volumeSize
integer <int32>
object (ZixiSettings)
zone
string

Responses

Request samples

Content type
application/json
{
  • "armArch": true,
  • "cdiSupportEnabled": true,
  • "cloudType": "AWS",
  • "deploymentType": "DOCKER",
  • "dns": "string",
  • "experimental": true,
  • "externalIp": "string",
  • "externalIpReservationId": "string",
  • "instanceName": "string",
  • "instancePort": 0,
  • "instanceType": "string",
  • "licenseId": "string",
  • "nixEnabled": true,
  • "region": "string",
  • "remoteId": "string",
  • "reuseIp": true,
  • "skipInstall": true,
  • "slots": 0,
  • "sshKey": "string",
  • "systemPassword": "string",
  • "systemUser": "string",
  • "type": "SD",
  • "vmType": "WINDOWS",
  • "volumeSize": 0,
  • "zixiSettings": {
    },
  • "zone": "string"
}

Response samples

Content type
application/json
{
  • "availableSlots": [
    ],
  • "cloudType": "AWS",
  • "dateCreated": "2019-08-24T14:15:22Z",
  • "dateUpdated": "2019-08-24T14:15:22Z",
  • "deploymentType": "DOCKER",
  • "deploymentVersion": 0,
  • "id": "string",
  • "instanceName": "string",
  • "internal": true,
  • "logShippingEnabled": true,
  • "nginxConfiguration": "string",
  • "organizationId": "string",
  • "osUpgradeAllowed": true,
  • "reservedSlots": {
    },
  • "scteListenerInstalled": true,
  • "securitySettings": {
    },
  • "serviceProviderId": "string",
  • "services": [
    ],
  • "templateType": "SD",
  • "version": 0,
  • "virtualMachineSettings": {
    },
  • "zixiInstalled": true,
  • "zixiSettings": {
    }
}

Delete instance by id

Delete instance

path Parameters
id
required
string

Instance id

query Parameters
organization
Array of strings

Organization Id

providerId
string

Responses

Response samples

Content type
application/json
{
  • "availableSlots": [
    ],
  • "cloudType": "AWS",
  • "dateCreated": "2019-08-24T14:15:22Z",
  • "dateUpdated": "2019-08-24T14:15:22Z",
  • "deploymentType": "DOCKER",
  • "deploymentVersion": 0,
  • "id": "string",
  • "instanceName": "string",
  • "internal": true,
  • "logShippingEnabled": true,
  • "nginxConfiguration": "string",
  • "organizationId": "string",
  • "osUpgradeAllowed": true,
  • "reservedSlots": {
    },
  • "scteListenerInstalled": true,
  • "securitySettings": {
    },
  • "serviceProviderId": "string",
  • "services": [
    ],
  • "templateType": "SD",
  • "version": 0,
  • "virtualMachineSettings": {
    },
  • "zixiInstalled": true,
  • "zixiSettings": {
    }
}

Find instance by id

Find instance

path Parameters
id
required
string

Instance id

query Parameters
organization
Array of strings

Organization Id

providerId
string

Responses

Response samples

Content type
application/json
{
  • "availableSlots": [
    ],
  • "cloudType": "AWS",
  • "dateCreated": "2019-08-24T14:15:22Z",
  • "dateUpdated": "2019-08-24T14:15:22Z",
  • "deploymentType": "DOCKER",
  • "deploymentVersion": 0,
  • "id": "string",
  • "instanceName": "string",
  • "internal": true,
  • "logShippingEnabled": true,
  • "nginxConfiguration": "string",
  • "organizationId": "string",
  • "osUpgradeAllowed": true,
  • "reservedSlots": {
    },
  • "scteListenerInstalled": true,
  • "securitySettings": {
    },
  • "serviceProviderId": "string",
  • "services": [
    ],
  • "templateType": "SD",
  • "version": 0,
  • "virtualMachineSettings": {
    },
  • "zixiInstalled": true,
  • "zixiSettings": {
    }
}

License resource

Get licenses

Returns licenses

Responses

Response samples

Content type
application/json
[
  • {
    }
]

Create a new license

Creates a new license

Request Body schema: application/json
required
dateCreated
string <date-time>
dateUpdated
string <date-time>
Array of objects (RegFile)
id
string
instanceId
string
licenseNumber
required
integer <int32>
organizationId
string
serviceProviderId
string
state
string
Enum: "AVAILABLE" "RESERVED" "IN_USE"
version
integer <int32>

Responses

Request samples

Content type
application/json
{
  • "dateCreated": "2019-08-24T14:15:22Z",
  • "dateUpdated": "2019-08-24T14:15:22Z",
  • "entries": [
    ],
  • "id": "string",
  • "instanceId": "string",
  • "licenseNumber": 0,
  • "organizationId": "string",
  • "serviceProviderId": "string",
  • "state": "AVAILABLE",
  • "version": 0
}

Response samples

Content type
application/json
{
  • "dateCreated": "2019-08-24T14:15:22Z",
  • "dateUpdated": "2019-08-24T14:15:22Z",
  • "entries": [
    ],
  • "id": "string",
  • "instanceId": "string",
  • "licenseNumber": 0,
  • "organizationId": "string",
  • "serviceProviderId": "string",
  • "state": "AVAILABLE",
  • "version": 0
}

Import license from zip

Creates new license

Request Body schema: multipart/form-data
file
required
string <binary>

Responses

Response samples

Content type
application/json
{
  • "dateCreated": "2019-08-24T14:15:22Z",
  • "dateUpdated": "2019-08-24T14:15:22Z",
  • "entries": [
    ],
  • "id": "string",
  • "instanceId": "string",
  • "licenseNumber": 0,
  • "organizationId": "string",
  • "serviceProviderId": "string",
  • "state": "AVAILABLE",
  • "version": 0
}

Delete license

Deletes license with given ID

path Parameters
id
required
string

License Id

Responses

Response samples

Content type
application/json
{ }

Get licenses

Returns licenses with given ID

path Parameters
id
required
string

License Id

Responses

Response samples

Content type
application/json
{
  • "dateCreated": "2019-08-24T14:15:22Z",
  • "dateUpdated": "2019-08-24T14:15:22Z",
  • "entries": [
    ],
  • "id": "string",
  • "instanceId": "string",
  • "licenseNumber": 0,
  • "organizationId": "string",
  • "serviceProviderId": "string",
  • "state": "AVAILABLE",
  • "version": 0
}

Update license

Updates license with given ID

path Parameters
licenseId
required
string

License Id

Request Body schema: application/json
required
dateCreated
string <date-time>
dateUpdated
string <date-time>
Array of objects (RegFile)
id
string
instanceId
string
licenseNumber
required
integer <int32>
organizationId
string
serviceProviderId
string
state
string
Enum: "AVAILABLE" "RESERVED" "IN_USE"
version
integer <int32>

Responses

Request samples

Content type
application/json
{
  • "dateCreated": "2019-08-24T14:15:22Z",
  • "dateUpdated": "2019-08-24T14:15:22Z",
  • "entries": [
    ],
  • "id": "string",
  • "instanceId": "string",
  • "licenseNumber": 0,
  • "organizationId": "string",
  • "serviceProviderId": "string",
  • "state": "AVAILABLE",
  • "version": 0
}

Response samples

Content type
application/json
{
  • "dateCreated": "2019-08-24T14:15:22Z",
  • "dateUpdated": "2019-08-24T14:15:22Z",
  • "entries": [
    ],
  • "id": "string",
  • "instanceId": "string",
  • "licenseNumber": 0,
  • "organizationId": "string",
  • "serviceProviderId": "string",
  • "state": "AVAILABLE",
  • "version": 0
}

Resource limit pack resource

Get resource limit packs

Returns available resource limit packs

Responses

Response samples

Content type
application/json
[
  • {
    }
]

Create resource limit pack

Request Body schema: application/json
required
accountNumber
integer <int32> >= 0
daysToExpiration
integer <int32> >= 0
id
string
ingestSize
integer <int64> >= 0
ingestSources
integer <int32> >= 0
liveEnabled
boolean
maxCloudPlayouts
integer <int32> >= 0
maxConcurrentIngests
integer <int32> [ 1 .. 20 ]
mediaStoreSize
integer <int64> >= 0
name
string
windowsFeaturesEnabled
boolean

Responses

Request samples

Content type
application/json
{
  • "accountNumber": 0,
  • "daysToExpiration": 0,
  • "id": "string",
  • "ingestSize": 0,
  • "ingestSources": 0,
  • "liveEnabled": true,
  • "maxCloudPlayouts": 0,
  • "maxConcurrentIngests": 1,
  • "mediaStoreSize": 0,
  • "name": "string",
  • "windowsFeaturesEnabled": true
}

Response samples

Content type
application/json
{
  • "accountNumber": 0,
  • "daysToExpiration": 0,
  • "id": "string",
  • "ingestSize": 0,
  • "ingestSources": 0,
  • "liveEnabled": true,
  • "maxCloudPlayouts": 0,
  • "maxConcurrentIngests": 1,
  • "mediaStoreSize": 0,
  • "name": "string",
  • "windowsFeaturesEnabled": true
}

Get default resource limit pack

Returns default resource limit pack

Responses

Response samples

Content type
application/json
{
  • "accountNumber": 0,
  • "daysToExpiration": 0,
  • "ingestSize": 0,
  • "ingestSources": 0,
  • "liveEnabled": true,
  • "maxCloudPlayouts": 0,
  • "maxConcurrentIngests": 0,
  • "mediaStoreSize": 0,
  • "windowsFeaturesEnabled": true
}

Delete resource limit pack

Delete resource limit pack by Id

path Parameters
resourceLimitPackId
required
string

Resource limit pack Id

Responses

Response samples

Content type
application/json
{
  • "code": 0,
  • "messages": [
    ]
}

Get resource limit pack

Returns resource limit pack found by Id

path Parameters
resourceLimitPackId
required
string

Resource limit pack Id

Responses

Response samples

Content type
application/json
{
  • "accountNumber": 0,
  • "daysToExpiration": 0,
  • "id": "string",
  • "ingestSize": 0,
  • "ingestSources": 0,
  • "liveEnabled": true,
  • "maxCloudPlayouts": 0,
  • "maxConcurrentIngests": 1,
  • "mediaStoreSize": 0,
  • "name": "string",
  • "windowsFeaturesEnabled": true
}

Update resource limit pack

Update resource limit pack

path Parameters
resourceLimitPackId
required
string

Resource limit pack Id

Request Body schema: application/json
required
accountNumber
integer <int32> >= 0
daysToExpiration
integer <int32> >= 0
id
string
ingestSize
integer <int64> >= 0
ingestSources
integer <int32> >= 0
liveEnabled
boolean
maxCloudPlayouts
integer <int32> >= 0
maxConcurrentIngests
integer <int32> [ 1 .. 20 ]
mediaStoreSize
integer <int64> >= 0
name
string
windowsFeaturesEnabled
boolean

Responses

Request samples

Content type
application/json
{
  • "accountNumber": 0,
  • "daysToExpiration": 0,
  • "id": "string",
  • "ingestSize": 0,
  • "ingestSources": 0,
  • "liveEnabled": true,
  • "maxCloudPlayouts": 0,
  • "maxConcurrentIngests": 1,
  • "mediaStoreSize": 0,
  • "name": "string",
  • "windowsFeaturesEnabled": true
}

Response samples

Content type
application/json
{
  • "accountNumber": 0,
  • "daysToExpiration": 0,
  • "id": "string",
  • "ingestSize": 0,
  • "ingestSources": 0,
  • "liveEnabled": true,
  • "maxCloudPlayouts": 0,
  • "maxConcurrentIngests": 1,
  • "mediaStoreSize": 0,
  • "name": "string",
  • "windowsFeaturesEnabled": true
}

Preset resource

Find all presets

Find presets

Responses

Response samples

Content type
application/json
[
  • {
    }
]

Create new preset

Creates preset

Request Body schema: application/json
required
dateCreated
string <date-time>
dateUpdated
string <date-time>
id
string
object (PresetValueInteger)
Array of objects (PlayoutInputPresetDTO) unique
object (PlayoutInstancePresetDTO)
name
string
organizationId
string
object (PresetValueInteger)
Array of objects (PlayoutOutputPresetDTO) unique
object (PresetValueScteListenerStrategy)
serviceProviderId
string
object (PresetValueBoolean)

Responses

Request samples

Content type
application/json
{
  • "dateCreated": "2019-08-24T14:15:22Z",
  • "dateUpdated": "2019-08-24T14:15:22Z",
  • "id": "string",
  • "inputCount": {
    },
  • "inputs": [
    ],
  • "instancePreset": {
    },
  • "name": "string",
  • "organizationId": "string",
  • "outputCount": {
    },
  • "outputs": [
    ],
  • "scteListenerStrategy": {
    },
  • "serviceProviderId": "string",
  • "zixiEnabled": {
    }
}

Response samples

Content type
application/json
{
  • "dateCreated": "2019-08-24T14:15:22Z",
  • "dateUpdated": "2019-08-24T14:15:22Z",
  • "id": "string",
  • "inputCount": {
    },
  • "inputs": [
    ],
  • "instancePreset": {
    },
  • "name": "string",
  • "organizationId": "string",
  • "outputCount": {
    },
  • "outputs": [
    ],
  • "scteListenerStrategy": {
    },
  • "serviceProviderId": "string",
  • "zixiEnabled": {
    }
}

Delete preset by id

Delete preset

path Parameters
id
required
string

Preset id

Responses

Response samples

Content type
application/json
{
  • "code": 0,
  • "messages": [
    ]
}

Find preset by id

Find preset

path Parameters
id
required
string

Preset id

Responses

Response samples

Content type
application/json
{
  • "dateCreated": "2019-08-24T14:15:22Z",
  • "dateUpdated": "2019-08-24T14:15:22Z",
  • "id": "string",
  • "inputCount": {
    },
  • "inputs": [
    ],
  • "instancePreset": {
    },
  • "name": "string",
  • "organizationId": "string",
  • "outputCount": {
    },
  • "outputs": [
    ],
  • "scteListenerStrategy": {
    },
  • "serviceProviderId": "string",
  • "zixiEnabled": {
    }
}