RBAC (Role/Resource based access control) is available upon request. Contact support or your contact person at LTN Global.
About: Policies allow for granular configuration of user permissions based on Live Video Cloud's resources and their available methods. Use the documented resources and methods as a reference to configure custom policies.
Hint: RBAC, roles, and policies are currently in closed beta. The list of resources, methods, and descriptions may not be complete and subject to change. Be aware that some resources may only be available to you if they are enabled for your respective Live Video Cloud team.
Resources:
- Teams
- Inputs
- Input sources
- Streams
- Productions
- Outputs
- Output destinations
- Assets
- Members
- Roles
- Policies
- Connected accounts
- Transfer targets
- Transfer jobs
- System usage
- Service regions
- Audit log events
- Long running operations
Teams
A team represents a group of resources and members having access to those resources.
Path:
/teams*
Methods:
| list | List all resources. |
| get | Request all information of a resource. |
| inviteUser | Invite new members to a team. |
Inputs
Path:
/inputs*
/inputs/{$inputID}*
Methods:
| list | List all resources. |
| get | Request all information of a resource. |
| create | Create a new resource. |
| update | Update an existing resource. Typically done by editing. |
| delete | Delete an existing resource. |
| getInputEndpoint | … |
| setMode | … |
Input sources
…
Path:
/inputs/*/sources*
/inputs/*/sources/{$sourceID}*
Methods:
| list | List all resources. |
| get | Request all information of a resource. |
| create | Create a new resource. |
| update | Update an existing resource. Typically done by editing. |
| delete | Delete an existing resource. |
Streams
Streams are the ingested live signals provided by inputs.
Path:
/streams*
/inputs/*/streams*
/inputs/{$inputID}/streams*
Methods:
| list | List all resources. |
| get | Request all information of a resource. |
Productions
See → Learn about productions.
Path:
/productions*
/productions/{$productionID}*
Methods:
| list | List all resources. |
| get | Request all information of a resource. |
| create | Create a new resource. |
| update | Update an existing resource. Typically done by editing. |
| delete | Delete an existing resource. |
| start | Start productions including all assigned inputs and outputs. |
| stop | Stop productions including all assigned inputs (if they are not used by another production) and outputs. |
| defragment | Refresh the animated multiview to remove empty tiles. |
| listStreams | List all incoming streams related to the production. |
| watch | … |
| assignInputToProduction | Add inputs to a production. Requires "get" for inputs. |
| withdrawInputFromProduction | Remove inputs from a production. |
| assignOutputToProduction | Add outputs to a production. Requires "get" for outputs. |
| withdrawOutputFromProduction | Remove outputs from a production. |
Outputs
Path:
/outputs*
/outputs/{$outputID}*
Methods:
| list | List all resources. |
| get | Request all information of a resource. |
| create | Create a new resource. |
| update | Update an existing resource. Typically done by editing. |
| delete | Delete an existing resource. |
| listOutputTranscodingConstraints | List transcoding quality constraints. Needed to configure transcoded outputs. |
| setOutputOverlay | Configure output overlays. |
| setOutputSource | Route streams to outputs. |
Output destinations
Output destinations are for example RTMP push, SRT caller, and social platforms.
Path:
/outputs/*/targets*
/outputs/*/targets/{$targetID}*
Methods:
| list | List all resources. |
| get | Request all information of a resource. |
| create | Create a new resource. |
| update | Update an existing resource. Typically done by editing. |
| delete | Delete an existing resource. |
| getOutputTargetProperties | … |
Assets
Path:
/videoassets*
Methods:
| list | List all resources. |
| get | Request all information of a resource. |
| delete | Delete an existing resource. |
| search | Filter assets by metadata. |
| download | Download an asset. |
| batchAddVideoAssetMetadata | … |
Members
Members are the users of your Live Video Cloud team.
Path:
/members*
/members/{$memberID}
Methods:
| list | List all resources. |
| get | … |
| delete | … |
Roles
Add description…
Path:
/roles*
/roles/{$roleID}*
/teams/*/rbac/roles*
/teams/*/rbac/roles/{$roleID}
Methods:
| list | List all resources. |
| get | Request all information of a resource. |
| create | Create a new resource. |
| update | Update an existing resource. Typically done by editing. |
| delete | Delete an existing resource. |
| inviteUser | Invite new members to a team. |
| addClient | … |
| removeClient | … |
| addUser | Add role to user. |
| removeUser | Remove role from user. |
| addPolicy | Add policy to role. |
| removePolicy | Remove policy from role. |
Policies
Add description…
Path:
/policies*
/policies/{$policyID}
/teams/*/rbac/policies*
/teams/*/rbac/policies/{$policyID}
Methods:
| list | List all resources. |
| get | Request all information of a resource. |
| create | Create a new resource. |
| update | Update an existing resource. Typically done by editing. |
| delete | Delete an existing resource. |
Connected accounts
See → Learn to create connected accounts.
Path:
/accounts*
/accounts/{$accountID}
Methods:
| list | List all resources. |
| get | Request all information of a resource. |
| create | Create a new resource. |
| update | Update an existing resource. Typically done by editing. |
| delete | Delete an existing resource. |
| connect | … |
| refresh | … |
Transfer targets
See → Learn to create transfer targets.
Path:
/transfertargets*
/transfertargets/{$transferTargetID}
Methods:
| list | List all resources. |
| get | Request all information of a resource. |
| create | Create a new resource. |
| update | Update an existing resource. Typically done by editing. |
| delete | Delete an existing resource. |
Transfer jobs
See → Learn about transfer jobs.
Path:
/transfers*
Methods:
| list | List all resources. |
| get | Request all information of a resource. |
| start |
System usage
See → Learn about system usage.
Path:
/usage*
/usage/egress/
/usage/liverecording/
/usage/outputs/
/usage/storage/
/usage/storage/peak/
Methods:
| createCsvDownloadUrl | Allows exporting usage data as CSV file. Only available for "/usage". |
| generate | … |
Service regions
Service regions are the data center location which can be configured for inputs and productions.
Path:
/serviceregions*
/serviceregions/{$serviceRegionID}*
Methods:
| list | List all resources. |
| get | Request all information of a resource. |
Audit log events
…
Path:
/auditlog/events*
/auditlog/events/{$eventID}*
Methods:
| get | Request all information of a resource. |
| search | Filter available records. |
Long running operations
…
Path:
Path is derived from the name of the operation.
Methods:
| list | List all resources. |
| get | Request all information of a resource. |
| cancel | … |