Difference between revisions of "VALT API"

From IVS Wiki
Jump to: navigation, search
 
(18 intermediate revisions by the same user not shown)
Line 1: Line 1:
−
 
+
{{Article - Manual | title = {{PAGENAME}} | content =
−
 
+
The <b>VALT REST API</b> allows control of nearly every feature within the VALT application from any external device capable of submitted API calls.
−
 
+
{{hr}}
−
 
+
<h1>Authentication</h1>
−
The VALT REST API allows control of nearly every feature within the VALT application from any external device capable of submitted API calls.  
+
<div style="column-count: 2;">
−
 
 
−
'''IMPORTANT: AN ENTERPRISE LICENSE IS REQUIRED TO LEVERAGE THE VALT API'''
 
−
 
 
−
==Authentication==
 
 
*[[API Authentication|Authentication]]
 
*[[API Authentication|Authentication]]
−
==Administration==
+
</div>
 +
{{hr}}
 +
<h1>Administration</h1>
 +
<div style="column-count: 2;">
 
* [[API Application Information|Application Information]]
 
* [[API Application Information|Application Information]]
 
* [[API List Media Servers|List Media Servers]]
 
* [[API List Media Servers|List Media Servers]]
 
* [[API Media Details|Media Server Details]]
 
* [[API Media Details|Media Server Details]]
 
* [[API List User Rights|List User Rights]]
 
* [[API List User Rights|List User Rights]]
−
===User Groups===
+
</div>
 +
{{hr - 2}}
 +
{{Manual lvl 2 | title = User Groups | content =  
 +
<div style="column-count: 2;">
 
* [[API List User Groups|List User Groups]]
 
* [[API List User Groups|List User Groups]]
 
* [[API User Group Details|User Group Details]]
 
* [[API User Group Details|User Group Details]]
Line 20: Line 22:
 
* [[API Update User Group|Update User Group]]
 
* [[API Update User Group|Update User Group]]
 
* [[API Delete User Group|Delete User Group]]
 
* [[API Delete User Group|Delete User Group]]
−
===Users===
+
</div>
 +
}}
 +
{{Manual lvl 2 | title = Users | content =  
 +
<div style="column-count: 2;">
 
* [[API List Users|List Users]]
 
* [[API List Users|List Users]]
 
* [[API User Details|User Details]]
 
* [[API User Details|User Details]]
Line 26: Line 31:
 
* [[API Update User|Update User]]
 
* [[API Update User|Update User]]
 
* [[API Delete User|Delete User]]
 
* [[API Delete User|Delete User]]
−
===Templates===
+
</div>
 +
}}
 +
{{Manual lvl 2 | title = Templates | content =  
 +
<div style="column-count: 2;">
 
* [[API Templates|Default Templates]]
 
* [[API Templates|Default Templates]]
 
* [[API List Templates|List Templates]]
 
* [[API List Templates|List Templates]]
Line 37: Line 45:
 
* [[API Update Template Fields|Update Template Fields]]
 
* [[API Update Template Fields|Update Template Fields]]
 
* [[API Remove Template Fields|Remove Template Fields]]
 
* [[API Remove Template Fields|Remove Template Fields]]
−
 
+
</div>
−
===Rooms===
+
}}
 +
{{Manual lvl 2 | title = Rooms | content =  
 +
<div style="column-count: 2;">
 
* [[API List Rooms|List Rooms]]
 
* [[API List Rooms|List Rooms]]
 
* [[API Room Details|Room Details]]
 
* [[API Room Details|Room Details]]
Line 48: Line 58:
 
* [[API Edit Marker|Edit Marker]]
 
* [[API Edit Marker|Edit Marker]]
 
* [[API Delete Marker|Delete Marker]]
 
* [[API Delete Marker|Delete Marker]]
−
 
+
</div>
−
===Cameras===
+
}}
 +
{{Manual lvl 2 | title = Cameras | content =  
 +
<div style="column-count: 2;">
 
* [[API List Cameras|List Cameras]]
 
* [[API List Cameras|List Cameras]]
 
* [[API Camera Details|Camera Details]]
 
* [[API Camera Details|Camera Details]]
Line 55: Line 67:
 
* [[API Update Camera|Update Camera]]
 
* [[API Update Camera|Update Camera]]
 
* [[API Delete Camera|Delete Camera]]
 
* [[API Delete Camera|Delete Camera]]
−
==Room Control==
+
</div>
 +
}}
 +
 
 +
 
 +
{{Top of Page}}
 +
{{hr}}
 +
<h1>Room Control</h1>
 +
<div style="column-count: 2;">
 
* [[API Room Details|Room Details]]
 
* [[API Room Details|Room Details]]
 
* [[API Room Status|Room Status]]
 
* [[API Room Status|Room Status]]
Line 64: Line 83:
 
* [[API Lock Room|Lock Room]]
 
* [[API Lock Room|Lock Room]]
 
* [[API Unlock Room|Unlock Room]]
 
* [[API Unlock Room|Unlock Room]]
−
==Markers==
+
* [[API List Camera Presets|List Camera Presets]]
 +
* [[API Create Camera Preset|Create Camera Preset]]
 +
* [[API Apply Camera Preset|Apply Camera Preset]]
 +
* [[API Delete Camera Preset|Delete Camera Preset]]
 +
</div>
 +
{{hr}}
 +
<h1>Markers (VALT 5.X)</h1>
 +
<div style="column-count: 2;">
 
* [[API List Markers|List Markers]]
 
* [[API List Markers|List Markers]]
 
* [[API Add Marker|Add Marker]]
 
* [[API Add Marker|Add Marker]]
 
* [[API Edit Marker|Edit Marker]]
 
* [[API Edit Marker|Edit Marker]]
 
* [[API Delete Marker|Delete Marker]]
 
* [[API Delete Marker|Delete Marker]]
−
==Recorded Videos==
+
</div>
 +
{{hr}}
 +
<h1>Comments (VALT 6.x)</h1>
 +
<div style="column-count: 2;">
 +
* [[API List Comments of a Recording|List Comments of a Recording]]
 +
* [[API View Comment|View Comment]]
 +
* [[API Add Comment|Add Comment]]
 +
* [[API Edit Comment|Edit Comment]]
 +
* [[API Get Comment File| Get Comment File]]
 +
* [[API Delete Comment|Delete Comment]]
 +
</div>
 +
{{hr}}
 +
<h1>Recorded Videos</h1>
 +
<div style="column-count: 2;">
 
* [[API List Recordings|List Recordings]]
 
* [[API List Recordings|List Recordings]]
 
* [[API Recording Details|Recording Details]]
 
* [[API Recording Details|Recording Details]]
Line 77: Line 116:
 
* [[API Create Sharing Link|Create Sharing Link]]
 
* [[API Create Sharing Link|Create Sharing Link]]
 
* [[API Remove Sharing Link|Remove Sharing Link]]
 
* [[API Remove Sharing Link|Remove Sharing Link]]
 +
* [[API Download Recording Video|Download Recording Video]]
 +
* [[API Upload Recording|Upload Recording]]
 
* [[API List Markers|List Markers]]
 
* [[API List Markers|List Markers]]
 
* [[API Add Marker|Add Marker]]
 
* [[API Add Marker|Add Marker]]
 
* [[API Edit Marker|Edit Marker]]
 
* [[API Edit Marker|Edit Marker]]
 
* [[API Delete Marker|Delete Marker]]
 
* [[API Delete Marker|Delete Marker]]
−
 
+
</div>
−
==Filters==
+
{{hr}}
 +
<h1>Filters</h1>
 +
<div style="column-count: 2;">
 
* [[API List Filters|List Filters]]
 
* [[API List Filters|List Filters]]
 
* [[API Filter Details|Filter Details]]
 
* [[API Filter Details|Filter Details]]
Line 89: Line 132:
 
* [[API Update Filter|Update Filter]]
 
* [[API Update Filter|Update Filter]]
 
* [[API Delete Filter|Delete Filter]]
 
* [[API Delete Filter|Delete Filter]]
−
==Schedules==
+
</div>
 +
{{hr}}
 +
<h1>Schedules</h1>
 +
<div style="column-count: 2;">
 
* [[API List Schedules|List Schedules]]
 
* [[API List Schedules|List Schedules]]
 
* [[API List Schedule Conflicts|List Schedule Conflicts]]
 
* [[API List Schedule Conflicts|List Schedule Conflicts]]
Line 98: Line 144:
 
* [[API Delete Next Instance|Delete Next Instance]]
 
* [[API Delete Next Instance|Delete Next Instance]]
 
* [[API Stop Schedule|Stop Schedule]]
 
* [[API Stop Schedule|Stop Schedule]]
 +
</div>
 +
 +
 +
{{Top of Page}}
 +
}}

Latest revision as of 11:14, 26 June 2026

The VALT REST API allows control of nearly every feature within the VALT application from any external device capable of submitted API calls.

Authentication

Administration

User Groups

Users

Templates

Rooms

Cameras


⇧ Back to Top

Room Control

Markers (VALT 5.X)

Comments (VALT 6.x)

Recorded Videos

Filters

Schedules


⇧ Back to Top
Retrieved from "https://ivs.help/wiki/index.php?title=VALT_API&oldid=17702"