API docs by Redocly

VidiNet Platform API

Download OpenAPI specification:Download

E-mail: info@vidispine.com URL: https://support.vidispine.com

Credentials

Generate token

Generate an access/refresh token pair.

Request Body schema: application/x-www-form-urlencoded
required
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
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
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

Request Body schema: application/json
required
service
required
string <uuid>
adminPassword
string

Password of the admin user of the affected VidiCore service. Not required for VidiEditor services.

Responses

Request samples

Content type
application/json
{
  • "service": "cd8c5e52-093e-43db-9c42-184f00e681dd",
  • "adminPassword": "string"
}

Response samples

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

Detach service

Detaches a service from a VidiCore service. Detaching a transcoding service from a VidiCore service removes it as a resource, making it unavailable for transcode jobs.

path Parameters
service_id
required
string <uuid>

VidiCore service id

Request Body schema: application/json
required
service
required
string <uuid>
adminPassword
string

Password of the admin user of the affected VidiCore service. Not required for VidiEditor services.

Responses

Request samples

Content type
application/json
{
  • "service": "cd8c5e52-093e-43db-9c42-184f00e681dd",
  • "adminPassword": "string"
}

Response samples

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

Service

List services

List all purchased, non-deleted, services accessible by the calling user.

Responses

Response samples

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

Create a service

Request Body schema: application/json
required
One of
region
required
string

AWS region, eg. 'eu-west-1' or 'us-east-1'

type
required
string
Value: "AWS_MEDIACONVERT"
name
required
string

The display name of the service. The name of the service is for the user to be able to identify it. It's arbitrary to VidiNet and does not have to be unique.

Responses

Request samples

Content type
application/json
Example
{
  • "region": "eu-west-1",
  • "type": "AWS_MEDIACONVERT",
  • "name": "string"
}

Response samples

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

Inspect a service

path Parameters
service_id
required
string <uuid>

Responses

Response samples

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

Delete a service

path Parameters
service_id
required
string <uuid>

Responses

Response samples

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

Update a service

Update one or more properties of a service. All properties are optional, only the given properties are updated.

path Parameters
service_id
required
string <uuid>
Request Body schema: application/json
required
One of
name
string

The display name of the service. Changing this property is immediate and require no downtime.

Responses

Request samples

Content type
application/json
Example
{
  • "name": "string"
}

Response samples

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

Get addon for a service.

path Parameters
service_id
required
string <uuid>
Request Body schema: application/json
uuid
string <uuid>
name
string

Responses

Request samples

Content type
application/json
{
  • "uuid": "095be615-a8ad-4c33-8e9c-c7612fbf6c9f",
  • "name": "string"
}

Response samples

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

Create an addon for a service.

path Parameters
service_id
required
string <uuid>
Request Body schema: application/json
uuid
string <uuid>
name
string

Responses

Request samples

Content type
application/json
{
  • "uuid": "095be615-a8ad-4c33-8e9c-c7612fbf6c9f",
  • "name": "string"
}

Response samples

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

Health

Ping

A simple health check.

Responses

Response samples

Content type
text/plain
pong

License

List Licenses

List your Licenses

Request Body schema: application/json
sortDirection
string (Direction)
Enum: "Ascending" "Descending"
sortBy
string
limit
integer <int32>
offset
integer <int32>
filters
Array of strings

Responses

Request samples

Content type
application/json
{
  • "sortDirection": "Ascending",
  • "sortBy": "string",
  • "limit": 0,
  • "offset": 0,
  • "filters": [
    ]
}

Response samples

Content type
application/json
[
  • {
    }
]

Create a new License

Create a License based on a License Offer by passing in the Product Code of the License Offer. To get available License Offers, first call the List License Offers endpoint. If this license should be attached to an existing VidiCore license, the parentLicenseId must be set to the id of the VidiCore License.

Request Body schema: application/json
required
name
required
string\S
productCode
required
string\S
parentLicenseId
string <uuid> (UUID) [a-fA-F0-9]{8}-[a-fA-F0-9]{4}-[a-fA-F0-9]{4}-...

Responses

Request samples

Content type
application/json
Example

Create a license based on the VC-DEV Product Code

{
  • "name": "My New VidiCore License",
  • "productCode": "VC-DEV"
}

Response samples

Content type
application/json
{
  • "id": "497f6eca-6276-4993-bfeb-53cbbbba6f08",
  • "name": "string",
  • "expirationDate": "2022-03-10",
  • "companyId": "8bb73d03-06b4-47c7-80c7-59301f770eda",
  • "createdBy": "25a02396-1048-48f9-bf93-102d2fb7895e",
  • "createdAt": "2022-03-10",
  • "licenseOffer": {
    },
  • "attributes": [
    ],
  • "mergedAttributes": [
    ],
  • "parentLicenseId": "f8540a33-5c22-4028-864f-d2cd6d366d73",
  • "childLicenses": [
    ]
}

Get a License by id

Get a License by the id

path Parameters
id
required
string <uuid> (UUID) [a-fA-F0-9]{8}-[a-fA-F0-9]{4}-[a-fA-F0-9]{4}-...

Responses

Response samples

Content type
application/json
{
  • "id": "497f6eca-6276-4993-bfeb-53cbbbba6f08",
  • "name": "string",
  • "expirationDate": "2022-03-10",
  • "companyId": "8bb73d03-06b4-47c7-80c7-59301f770eda",
  • "createdBy": "25a02396-1048-48f9-bf93-102d2fb7895e",
  • "createdAt": "2022-03-10",
  • "licenseOffer": {
    },
  • "attributes": [
    ],
  • "mergedAttributes": [
    ],
  • "parentLicenseId": "f8540a33-5c22-4028-864f-d2cd6d366d73",
  • "childLicenses": [
    ]
}

Delete the License

This will delete the license permanently. Any system currently using this license will stop working.

path Parameters
id
required
string <uuid> (UUID) [a-fA-F0-9]{8}-[a-fA-F0-9]{4}-[a-fA-F0-9]{4}-...

Responses

Response samples

Content type
application/json
{
  • "error": "string"
}

Update the License

Update the display name of the License

path Parameters
id
required
string <uuid> (UUID) [a-fA-F0-9]{8}-[a-fA-F0-9]{4}-[a-fA-F0-9]{4}-...
Request Body schema: application/json
required
name
string

Responses

Request samples

Content type
application/json

Updates the display name of the License

{
  • "name": "My New License Name"
}

Response samples

Content type
application/json
{
  • "id": "497f6eca-6276-4993-bfeb-53cbbbba6f08",
  • "name": "string",
  • "expirationDate": "2022-03-10",
  • "companyId": "8bb73d03-06b4-47c7-80c7-59301f770eda",
  • "createdBy": "25a02396-1048-48f9-bf93-102d2fb7895e",
  • "createdAt": "2022-03-10",
  • "licenseOffer": {
    },
  • "attributes": [
    ],
  • "mergedAttributes": [
    ],
  • "parentLicenseId": "f8540a33-5c22-4028-864f-d2cd6d366d73",
  • "childLicenses": [
    ]
}

Download the License

Download the license configuration which can be injected into VidiCore.

path Parameters
id
required
string <uuid> (UUID) [a-fA-F0-9]{8}-[a-fA-F0-9]{4}-[a-fA-F0-9]{4}-...

Responses

Response samples

Content type
application/octet-stream

Example of returned License configuration

SlaveIdentifier=VC-DEV-20230918074126-27aba411-7f51-45fe-ac9c-3e7914eaf88e
MasterIP=https://gateway.vidinet.net

List License Offers

List the License Offers that are available for purchase

Responses

Response samples

Content type
application/json
[
  • {
    }
]