Monitoring

Download OpenAPI specification:Download

Notification Events

Notification Events API

Get subscription sets

Returns subscription sets

query Parameters
organization
Array of strings

Organization Id

providerId
string

Service Provider Id

Responses

Response samples

Content type
application/json
[
  • {
    }
]

Creates subscription set

Returns subscription set

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>
enabled
boolean
Array of objects (EventSubscriber)
id
string
name
string
organization
string
providerId
string
Array of objects (EventSubscription)
timeZone
string

Responses

Request samples

Content type
application/json
{
  • "dateCreated": "2019-08-24T14:15:22Z",
  • "dateUpdated": "2019-08-24T14:15:22Z",
  • "enabled": true,
  • "eventSubscribers": [
    ],
  • "id": "string",
  • "name": "string",
  • "organization": "string",
  • "providerId": "string",
  • "subscriptions": [
    ],
  • "timeZone": "string"
}

Response samples

Content type
application/json
{
  • "dateCreated": "2019-08-24T14:15:22Z",
  • "dateUpdated": "2019-08-24T14:15:22Z",
  • "enabled": true,
  • "eventSubscribers": [
    ],
  • "id": "string",
  • "name": "string",
  • "organization": "string",
  • "providerId": "string",
  • "subscriptions": [
    ],
  • "timeZone": "string"
}

Delete subscription set

path Parameters
id
required
string
query Parameters
organization
Array of strings

Organization Id

providerId
string

Service Provider Id

Responses

Response samples

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

Get subscription set

Returns subscription set

path Parameters
id
required
string
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",
  • "dateUpdated": "2019-08-24T14:15:22Z",
  • "enabled": true,
  • "eventSubscribers": [
    ],
  • "id": "string",
  • "name": "string",
  • "organization": "string",
  • "providerId": "string",
  • "subscriptions": [
    ],
  • "timeZone": "string"
}

Updates subscription set

Returns subscription set

path Parameters
id
required
string
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>
enabled
boolean
Array of objects (EventSubscriber)
id
string
name
string
organization
string
providerId
string
Array of objects (EventSubscription)
timeZone
string

Responses

Request samples

Content type
application/json
{
  • "dateCreated": "2019-08-24T14:15:22Z",
  • "dateUpdated": "2019-08-24T14:15:22Z",
  • "enabled": true,
  • "eventSubscribers": [
    ],
  • "id": "string",
  • "name": "string",
  • "organization": "string",
  • "providerId": "string",
  • "subscriptions": [
    ],
  • "timeZone": "string"
}

Response samples

Content type
application/json
{
  • "dateCreated": "2019-08-24T14:15:22Z",
  • "dateUpdated": "2019-08-24T14:15:22Z",
  • "enabled": true,
  • "eventSubscribers": [
    ],
  • "id": "string",
  • "name": "string",
  • "organization": "string",
  • "providerId": "string",
  • "subscriptions": [
    ],
  • "timeZone": "string"
}

Updates subscription set subscribes

Returns subscription set

path Parameters
id
required
string
query Parameters
organization
Array of strings

Organization Id

providerId
string

Service Provider Id

Request Body schema: application/json
required
Array
deliveryMode
string
Enum: "ALL" "TRIGGERED" "RELEASED"
id
string
organizations
Array of strings unique
subscriptionData
object
type
string
Enum: "EMAIL" "USER" "WEB_HOOK"

Responses

Request samples

Content type
application/json
[
  • {
    }
]

Response samples

Content type
application/json
{
  • "dateCreated": "2019-08-24T14:15:22Z",
  • "dateUpdated": "2019-08-24T14:15:22Z",
  • "enabled": true,
  • "eventSubscribers": [
    ],
  • "id": "string",
  • "name": "string",
  • "organization": "string",
  • "providerId": "string",
  • "subscriptions": [
    ],
  • "timeZone": "string"
}

Unsubscribes user from set

path Parameters
id
required
string
secret
required
string

Responses

Response samples

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

Validate web hook subscriber

path Parameters
id
required
string
query Parameters
organization
Array of strings

Organization Id

providerId
string

Service Provider Id

Request Body schema: application/json
required
deliveryMode
string
Enum: "ALL" "TRIGGERED" "RELEASED"
id
string
organizations
Array of strings unique
subscriptionData
object
type
string
Enum: "EMAIL" "USER" "WEB_HOOK"

Responses

Request samples

Content type
application/json
{
  • "deliveryMode": "ALL",
  • "id": "string",
  • "organizations": [
    ],
  • "subscriptionData": { },
  • "type": "EMAIL"
}

Response samples

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

Updates subscription set subscribes

Returns subscription set

path Parameters
id
required
string
secret
required
string

Responses

Response samples

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

Creates subscription set subscription

Returns subscription set

path Parameters
setId
required
string
query Parameters
organization
Array of strings

Organization Id

providerId
string

Service Provider Id

Request Body schema: application/json
required
id
string
name
string
properties
object (SubscriptionData)
type
required
string
Enum: "JOB" "PLAYOUT_GAP" "PLAYLIST_APPLY" "AVMON" "EMERGENCY" "PLAYOUT_STATUS" "PLAYOUT_MEMORY" "PLAYOUT_CPU" "PLAYOUT_STORAGE" "PLAYOUT_CONNECTION" "PLAYOUT_PLAYBACK" "PLAYOUT_FILEDESCRIPTORS" "LIVE_INPUT_STATUS" "PREVIEW_STATUS" "PLAYOUT_ERROR"

Responses

Request samples

Content type
application/json
{
  • "id": "string",
  • "name": "string",
  • "properties": { },
  • "type": "JOB"
}

Response samples

Content type
application/json
{
  • "dateCreated": "2019-08-24T14:15:22Z",
  • "dateUpdated": "2019-08-24T14:15:22Z",
  • "enabled": true,
  • "eventSubscribers": [
    ],
  • "id": "string",
  • "name": "string",
  • "organization": "string",
  • "providerId": "string",
  • "subscriptions": [
    ],
  • "timeZone": "string"
}

Updates subscription set subscription

Returns subscription set

path Parameters
setId
required
string
subscriptionId
required
string
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",
  • "dateUpdated": "2019-08-24T14:15:22Z",
  • "enabled": true,
  • "eventSubscribers": [
    ],
  • "id": "string",
  • "name": "string",
  • "organization": "string",
  • "providerId": "string",
  • "subscriptions": [
    ],
  • "timeZone": "string"
}

Updates subscription set subscription

Returns subscription set

path Parameters
setId
required
string
subscriptionId
required
string
query Parameters
organization
Array of strings

Organization Id

providerId
string

Service Provider Id

Request Body schema: application/json
required
id
string
name
string
properties
object (SubscriptionData)
type
required
string
Enum: "JOB" "PLAYOUT_GAP" "PLAYLIST_APPLY" "AVMON" "EMERGENCY" "PLAYOUT_STATUS" "PLAYOUT_MEMORY" "PLAYOUT_CPU" "PLAYOUT_STORAGE" "PLAYOUT_CONNECTION" "PLAYOUT_PLAYBACK" "PLAYOUT_FILEDESCRIPTORS" "LIVE_INPUT_STATUS" "PREVIEW_STATUS" "PLAYOUT_ERROR"

Responses

Request samples

Content type
application/json
{
  • "id": "string",
  • "name": "string",
  • "properties": { },
  • "type": "JOB"
}

Response samples

Content type
application/json
{
  • "dateCreated": "2019-08-24T14:15:22Z",
  • "dateUpdated": "2019-08-24T14:15:22Z",
  • "enabled": true,
  • "eventSubscribers": [
    ],
  • "id": "string",
  • "name": "string",
  • "organization": "string",
  • "providerId": "string",
  • "subscriptions": [
    ],
  • "timeZone": "string"
}

Monitoring Events

Monitoring Events API

Get monitoring events

Returns monitoring events

query Parameters
organization
Array of strings

Organization Id

providerId
string

Service Provider Id

playoutId
string

Playout Id

Responses

Response samples

Content type
application/json
[
  • {
    }
]

Create a new monitoring event

Request Body schema: application/json
required
actions
Array of strings
condition
string
dateCreated
string <date-time>
dateUpdated
string <date-time>
description
string
enabled
boolean
id
string
name
string
organizationId
string
playoutId
string
priority
integer <int32>
serviceProviderId
string

Responses

Request samples

Content type
application/json
{
  • "actions": [
    ],
  • "condition": "string",
  • "dateCreated": "2019-08-24T14:15:22Z",
  • "dateUpdated": "2019-08-24T14:15:22Z",
  • "description": "string",
  • "enabled": true,
  • "id": "string",
  • "name": "string",
  • "organizationId": "string",
  • "playoutId": "string",
  • "priority": 0,
  • "serviceProviderId": "string"
}

Response samples

Content type
application/json
{
  • "actions": [
    ],
  • "condition": "string",
  • "dateCreated": "2019-08-24T14:15:22Z",
  • "dateUpdated": "2019-08-24T14:15:22Z",
  • "description": "string",
  • "enabled": true,
  • "id": "string",
  • "name": "string",
  • "organizationId": "string",
  • "playoutId": "string",
  • "priority": 0,
  • "serviceProviderId": "string"
}

Migrate events to different SP

Migrate events to different SP

path Parameters
id
required
string

Organization id

Request Body schema: application/json
required
string

Responses

Request samples

Content type
application/json
"string"

Response samples

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

Update warm backup events

Update warm backup events

path Parameters
id
required
string

Playout id

query Parameters
organization
required
string

Playout backup settings

providerId
required
string

Responses

Response samples

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

Create warm backup events

Create warm backup events

path Parameters
id
required
string

Playout id

query Parameters
organization
required
string
providerId
required
string
Request Body schema: application/json
required
backupPlayoutId
string
backupType
string
Enum: "HOT" "WARM"
cacheForHours
integer <int64>
failoverDisabled
boolean
healthyPeriod
integer <int64>
maxWarmBackupUptimeHours
integer <int32>
startCachingMillis
integer <int64>
unhealthyPeriod
integer <int64>
wakeUpForCaching
boolean
wakeUpOnTimelineChange
boolean

Responses

Request samples

Content type
application/json
{
  • "backupPlayoutId": "string",
  • "backupType": "HOT",
  • "cacheForHours": 0,
  • "failoverDisabled": true,
  • "healthyPeriod": 0,
  • "maxWarmBackupUptimeHours": 0,
  • "startCachingMillis": 0,
  • "unhealthyPeriod": 0,
  • "wakeUpForCaching": true,
  • "wakeUpOnTimelineChange": true
}

Response samples

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

Update warm backup events

Update warm backup events

path Parameters
id
required
string

Playout id

query Parameters
organization
required
string
providerId
required
string
Request Body schema: application/json
required
backupPlayoutId
string
backupType
string
Enum: "HOT" "WARM"
cacheForHours
integer <int64>
failoverDisabled
boolean
healthyPeriod
integer <int64>
maxWarmBackupUptimeHours
integer <int32>
startCachingMillis
integer <int64>
unhealthyPeriod
integer <int64>
wakeUpForCaching
boolean
wakeUpOnTimelineChange
boolean

Responses

Request samples

Content type
application/json
{
  • "backupPlayoutId": "string",
  • "backupType": "HOT",
  • "cacheForHours": 0,
  • "failoverDisabled": true,
  • "healthyPeriod": 0,
  • "maxWarmBackupUptimeHours": 0,
  • "startCachingMillis": 0,
  • "unhealthyPeriod": 0,
  • "wakeUpForCaching": true,
  • "wakeUpOnTimelineChange": true
}

Response samples

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

Delete monitoring event

Delete monitoring event by its id

path Parameters
eventId
required
string

Monitoring event Id

Responses

Response samples

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

Get monitoring event

Returns a monitoring event by its id

path Parameters
eventId
required
string

Monitoring event id

Responses

Response samples

Content type
application/json
{
  • "actions": [
    ],
  • "condition": "string",
  • "dateCreated": "2019-08-24T14:15:22Z",
  • "dateUpdated": "2019-08-24T14:15:22Z",
  • "description": "string",
  • "enabled": true,
  • "id": "string",
  • "name": "string",
  • "organizationId": "string",
  • "playoutId": "string",
  • "priority": 0,
  • "serviceProviderId": "string"
}

Update monitoring event

Update monitoring event

path Parameters
eventId
required
string

Monitoring event id

Request Body schema: application/json
required
actions
Array of strings
condition
string
dateCreated
string <date-time>
dateUpdated
string <date-time>
description
string
enabled
boolean
id
string
name
string
organizationId
string
playoutId
string
priority
integer <int32>
serviceProviderId
string

Responses

Request samples

Content type
application/json
{
  • "actions": [
    ],
  • "condition": "string",
  • "dateCreated": "2019-08-24T14:15:22Z",
  • "dateUpdated": "2019-08-24T14:15:22Z",
  • "description": "string",
  • "enabled": true,
  • "id": "string",
  • "name": "string",
  • "organizationId": "string",
  • "playoutId": "string",
  • "priority": 0,
  • "serviceProviderId": "string"
}

Response samples

Content type
application/json
{
  • "actions": [
    ],
  • "condition": "string",
  • "dateCreated": "2019-08-24T14:15:22Z",
  • "dateUpdated": "2019-08-24T14:15:22Z",
  • "description": "string",
  • "enabled": true,
  • "id": "string",
  • "name": "string",
  • "organizationId": "string",
  • "playoutId": "string",
  • "priority": 0,
  • "serviceProviderId": "string"
}