Management API

The Management API allows you to integrate Vindral into your systems and manage channels.

API Reference

Read the API reference for in-depth information on routes or read on below for permission model and examples.

API Keys and Permissions

To access the API you need an account in the Vindral Portal and then create an API Key. The API Key used for authentication is tied to a user and shares the permissions of that user which is configured in the Vindral Portal. In addition to the user level permissions each API key has a scope of either read-only or read-write.

The tables below specify the set of permissions associated with each role. For API Keys with read-only scope Create/Update/Delete is always forbidden.

Administrator

Entity	Read	Create	Update	Delete
Channel	Yes	Yes	Yes	Yes
Channel Group	Yes	Yes	Yes	Yes
Transcoding Profiles	Yes	No	No	No

Channel Manager

Entity	Read	Create	Update	Delete
Channel	Yes	Yes	Yes	Yes
Channel Group	Yes	Yes	Yes	Yes
Transcoding Profiles	Yes	No	No	No

User

Entity	Read	Create	Update	Delete
Channel	Yes	No	No	No
Channel Group	Yes	No	No	No
Transcoding Profiles	Yes	No	No	No