Documentation Powered by ReDoc

VidiNet Public API (1.0.0)

Download OpenAPI specification:Download

Vidispine Support: info@vidispine.com URL: https://support.vidispine.com

VidiNets public API.

Credentials

Generate token

Generate an access/refresh token pair.

Request Body schema: application/x-www-form-urlencoded
One of
password
required
string
username
required
string
grant_type
required
string
Enum: "password" "mfa"
mfa_code
string

Responses

Response samples

Content type
application/json
{
  • "access_token": "VHVlIE5vdiAjAyMAo=",
  • "refresh_token": "QgMjAyMAo=",
  • "token_type": "password",
  • "expires_in": 10
}

Service Access Key

List access keys

Fetches all access keys of a transcoder service.

path Parameters
service_id
required
string <uuid>
Request Body schema: application/json
required
object (DataExistingAccessKeyRepresentation)

Responses

Request samples

Content type
application/json
{
  • "data": {
    }
}

Response samples

Content type
application/json
{
  • "data": { }
}

Create access key

Create an access key for a transcoder service. Access keys are required when (manually) adding a transcoder service as a resource in VidiCore.

path Parameters
service_id
required
string <uuid>

Responses

Response samples

Content type
application/json
{
  • "data": {
    }
}

Delete an access key

path Parameters
service_id
required
string <uuid>
access_key_id
required
string <uuid>

Responses

Response samples

Content type
application/json
{
  • "data": { }
}

Update an access key

Update one or more properties of an access key. All properties are optional, only the given properties are updated.

path Parameters
service_id
required
string <uuid>
access_key_id
required
string <uuid>
Request Body schema: application/json
required
object (UpdateAccessKeyRequest)

Responses

Request samples

Content type
application/json
{
  • "data": {
    }
}

Response samples

Content type
application/json
{
  • "data": { }
}

Service Attachment

List attachments

Fetches a list of all attachments of a service and their status.

path Parameters
service_id
required
string <uuid>

Responses

Response samples

Content type
application/json
{
  • "data": {
    }
}

Attach service

Attaches a service to a VidiCore service. Attaching a transcoding service to a VidiCore service adds it as a resource, making it available for transcode jobs. Attaching a VSA or a VidiEditor service to a VidiCore service configures the VidiCore to be used with the service.

path Parameters
<
service_id
required
string <uuid>

VidiCore service id