Monitoring

Download OpenAPI specification:Download

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

Services

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

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

200
401
403
404
500

Content type

application/json

[{"dateCreated": "2019-08-24T14:15:22Z",
"dateUpdated": "2019-08-24T14:15:22Z",
"enabled": true,
"eventSubscribers": [{"deliveryMode": "ALL",
"enabled": true,
"id": "string",
"organizations": ["string"
],
"subscriptionData": { },
"type": "EMAIL"
}
],
"id": "string",
"name": "string",
"organization": "string",
"providerId": "string",
"subscriptions": [{"id": "string",
"name": "string",
"properties": { },
"type": "JOB"
}
],
"timeZone": "string"
}
]

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

Payload

Content type

application/json

{"dateCreated": "2019-08-24T14:15:22Z",
"dateUpdated": "2019-08-24T14:15:22Z",
"enabled": true,
"eventSubscribers": [{"deliveryMode": "ALL",
"enabled": true,
"id": "string",
"organizations": ["string"
],
"subscriptionData": { },
"type": "EMAIL"
}
],
"id": "string",
"name": "string",
"organization": "string",
"providerId": "string",
"subscriptions": [{"id": "string",
"name": "string",
"properties": { },
"type": "JOB"
}
],
"timeZone": "string"
}

Response samples

200
401
403
404
500

Content type

application/json

{"dateCreated": "2019-08-24T14:15:22Z",
"dateUpdated": "2019-08-24T14:15:22Z",
"enabled": true,
"eventSubscribers": [{"deliveryMode": "ALL",
"enabled": true,
"id": "string",
"organizations": ["string"
],
"subscriptionData": { },
"type": "EMAIL"
}
],
"id": "string",
"name": "string",
"organization": "string",
"providerId": "string",
"subscriptions": [{"id": "string",
"name": "string",
"properties": { },
"type": "JOB"
}
],
"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

401
403
404
500

Content type

application/json

{"code": 0,
"messages": ["string"
]
}

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

200
401
403
404
500

Content type

application/json

{"dateCreated": "2019-08-24T14:15:22Z",
"dateUpdated": "2019-08-24T14:15:22Z",
"enabled": true,
"eventSubscribers": [{"deliveryMode": "ALL",
"enabled": true,
"id": "string",
"organizations": ["string"
],
"subscriptionData": { },
"type": "EMAIL"
}
],
"id": "string",
"name": "string",
"organization": "string",
"providerId": "string",
"subscriptions": [{"id": "string",
"name": "string",
"properties": { },
"type": "JOB"
}
],
"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

Payload

Content type

application/json

{"dateCreated": "2019-08-24T14:15:22Z",
"dateUpdated": "2019-08-24T14:15:22Z",
"enabled": true,
"eventSubscribers": [{"deliveryMode": "ALL",
"enabled": true,
"id": "string",
"organizations": ["string"
],
"subscriptionData": { },
"type": "EMAIL"
}
],
"id": "string",
"name": "string",
"organization": "string",
"providerId": "string",
"subscriptions": [{"id": "string",
"name": "string",
"properties": { },
"type": "JOB"
}
],
"timeZone": "string"
}

Response samples

200
401
403
404
500

Content type

application/json

{"dateCreated": "2019-08-24T14:15:22Z",
"dateUpdated": "2019-08-24T14:15:22Z",
"enabled": true,
"eventSubscribers": [{"deliveryMode": "ALL",
"enabled": true,
"id": "string",
"organizations": ["string"
],
"subscriptionData": { },
"type": "EMAIL"
}
],
"id": "string",
"name": "string",
"organization": "string",
"providerId": "string",
"subscriptions": [{"id": "string",
"name": "string",
"properties": { },
"type": "JOB"
}
],
"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"
enabled	boolean
id	string
organizations	Array of strings unique
subscriptionData	object
type	string Enum: "EMAIL" "USER" "WEB_HOOK"

Responses

Request samples

Payload

Content type

application/json

[{"deliveryMode": "ALL",
"enabled": true,
"id": "string",
"organizations": ["string"
],
"subscriptionData": { },
"type": "EMAIL"
}
]

Response samples

200
401
403
404
500

Content type

application/json

{"dateCreated": "2019-08-24T14:15:22Z",
"dateUpdated": "2019-08-24T14:15:22Z",
"enabled": true,
"eventSubscribers": [{"deliveryMode": "ALL",
"enabled": true,
"id": "string",
"organizations": ["string"
],
"subscriptionData": { },
"type": "EMAIL"
}
],
"id": "string",
"name": "string",
"organization": "string",
"providerId": "string",
"subscriptions": [{"id": "string",
"name": "string",
"properties": { },
"type": "JOB"
}
],
"timeZone": "string"
}

Unsubscribes user from set

path Parameters

id required	string
secret required	string

Responses

Response samples

401
403
404
500

Content type

application/json

{"code": 0,
"messages": ["string"
]
}

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"
enabled	boolean
id	string
organizations	Array of strings unique
subscriptionData	object
type	string Enum: "EMAIL" "USER" "WEB_HOOK"

Responses

Request samples

Payload

Content type

application/json

{"deliveryMode": "ALL",
"enabled": true,
"id": "string",
"organizations": ["string"
],
"subscriptionData": { },
"type": "EMAIL"
}

Response samples

200
401
403
404
500

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

401
403
404
500

Content type

application/json

{"code": 0,
"messages": ["string"
]
}

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" "INGEST_STATUS"

Responses

Request samples

Payload

Content type

application/json

{"id": "string",
"name": "string",
"properties": { },
"type": "JOB"
}

Response samples

200
401
403
404
500

Content type

application/json

{"dateCreated": "2019-08-24T14:15:22Z",
"dateUpdated": "2019-08-24T14:15:22Z",
"enabled": true,
"eventSubscribers": [{"deliveryMode": "ALL",
"enabled": true,
"id": "string",
"organizations": ["string"
],
"subscriptionData": { },
"type": "EMAIL"
}
],
"id": "string",
"name": "string",
"organization": "string",
"providerId": "string",
"subscriptions": [{"id": "string",
"name": "string",
"properties": { },
"type": "JOB"
}
],
"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

200
401
403
404
500

Content type

application/json

{"dateCreated": "2019-08-24T14:15:22Z",
"dateUpdated": "2019-08-24T14:15:22Z",
"enabled": true,
"eventSubscribers": [{"deliveryMode": "ALL",
"enabled": true,
"id": "string",
"organizations": ["string"
],
"subscriptionData": { },
"type": "EMAIL"
}
],
"id": "string",
"name": "string",
"organization": "string",
"providerId": "string",
"subscriptions": [{"id": "string",
"name": "string",
"properties": { },
"type": "JOB"
}
],
"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" "INGEST_STATUS"

Responses

Request samples

Payload

Content type

application/json

{"id": "string",
"name": "string",
"properties": { },
"type": "JOB"
}

Response samples

200
401
403
404
500

Content type

application/json

{"dateCreated": "2019-08-24T14:15:22Z",
"dateUpdated": "2019-08-24T14:15:22Z",
"enabled": true,
"eventSubscribers": [{"deliveryMode": "ALL",
"enabled": true,
"id": "string",
"organizations": ["string"
],
"subscriptionData": { },
"type": "EMAIL"
}
],
"id": "string",
"name": "string",
"organization": "string",
"providerId": "string",
"subscriptions": [{"id": "string",
"name": "string",
"properties": { },
"type": "JOB"
}
],
"timeZone": "string"
}

Monitoring

Services

Notification Events

Get subscription sets

query Parameters

Responses

Response samples

Creates subscription set

query Parameters

Request Body schema: application/jsonrequired

Responses

Request samples

Response samples

Delete subscription set

path Parameters

query Parameters

Responses

Response samples

Get subscription set

path Parameters

query Parameters

Responses

Response samples

Updates subscription set

path Parameters

query Parameters

Request Body schema: application/jsonrequired

Responses

Request samples

Response samples

Updates subscription set subscribes

path Parameters

query Parameters

Request Body schema: application/jsonrequired

Responses

Request samples

Response samples

Unsubscribes user from set

path Parameters

Responses

Response samples

Validate web hook subscriber

path Parameters

query Parameters

Request Body schema: application/jsonrequired

Responses

Request samples

Response samples

Updates subscription set subscribes

path Parameters

Responses

Response samples

Creates subscription set subscription

path Parameters

query Parameters

Request Body schema: application/jsonrequired

Responses

Request samples

Response samples

Updates subscription set subscription

path Parameters

query Parameters

Responses

Response samples

Updates subscription set subscription

path Parameters

query Parameters

Request Body schema: application/jsonrequired

Responses

Request samples

Response samples

Request Body schema: application/json
required

Request Body schema: application/json
required

Request Body schema: application/json
required

Request Body schema: application/json
required

Request Body schema: application/json
required

Request Body schema: application/json
required