Skip to main content
Version: v1

Enable VOD

This method enables the VOD functionality

info

A successful request will create a task whose progress can be tracked using the Tasks API

Request Parameters

POST /api/clients/v1/vod/{id}/enableVod/

Headers

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

Path

ParameterTypeConstraintsDescriptionExample
idinteger> 0, requiredVOD object ID19

Response Parameters

JSON body

ParameterTypeDescription
task_idstringTask ID

Examples

200 OK

VOD enablement task ID

{
"task_id": "bb4dcd80-01a5-4a73-8c2b-62c5027a9b72"
}
400 Bad Request

Invalid path parameters provided

{
"id": [
"A valid integer is required."
]
}
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 enablement is only allowed for project participants associated with its source

{
"detail": "Only project participants can manage this project's VOD"
}
404 Not Found

VOD object with this ID not found

{
"detail": "VOD not found"
}