Skip to main content
Version: v1

Create VOD Object

This method creates a VOD object (registers a video source)

note

After source registration, the VOD functionality is inactive by default. To start using VOD, you need to enable it

Request Parameters

POST /api/clients/v1/vod/

Headers

  • Content-Type: application/json
  • Authorization: Bearer $access_token

JSON body

ParameterTypeConstraintsDescriptionExample
source_typestrings3_bucket / domain, requiredVideo source types3_bucket
source_idinteger> 0, requiredVideo source ID52

Response Parameters

JSON body

ParameterTypeDescription
idintegerVOD object ID
vod_domainstringVOD domain name
source_typestringVideo source type
source_idintegerVideo source ID
is_activebooleanVOD function status

Examples

201 Created

VOD object

{
"id": 19,
"vod_domain": "vs52.vod-clients.cdn.itglobal.com",
"source_type": "s3_bucket",
"source_id": 52,
"is_active": false
}
400 Bad Request

Invalid or missing required body parameters

{
"source_type": [
"\"s3_resource\" is not a valid choice."
]
}
401 Unauthorized

Authentication credentials were missing or invalid

{
"detail": "Given token not valid for any token type",
"code": "token_not_valid",
"messages": [
{
"token_class": "AccessToken",
"token_type": "access",
"message": "Token is invalid or expired"
}
]
}
403 Forbidden

VOD can only be connected to sources belonging to your project

{
"detail": "Only project participants can manage this project's VOD"
}
409 Conflict

VOD for this source already exists

{
"detail": "VOD for this source already exists"
}