Configuration

Download OpenAPI specification:Download

Service provider resource

Service provider resource

Removes existing region for provider cloud configuration and cleanups cloud resources

Returns Org cloudconfiguration

path Parameters
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": [
    ]
}

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

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

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
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",
  • "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",
  • "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
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",
  • "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",
  • "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",
  • "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
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",
  • "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",
  • "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,
  • "graphicsProject": "string",
  • "graphicsProjectV2": "string",
  • "hardwareId": "string",
  • "id": "string",
  • "ignoreTimecode": true,
  • "instanceInfo": {
    },
  • "instanceType": "AWS",
  • "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

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,
  • "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": [