Difference between revisions of "VALT API"
IVSWikiBlue (talk | contribs) |
IVSWikiBlue (talk | contribs) |
||
| (10 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}} | ||
| − | + | =Authentication= | |
| + | *[[API Authentication|Authentication]] | ||
| − | {{ | + | {{hr}} |
| − | + | =Administration= | |
| − | |||
| − | |||
* [[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]] | ||
| − | + | ||
| + | {{hr - 2}} | ||
| + | |||
| + | ==User Groups== | ||
* [[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 17: | 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]] | ||
| − | + | ||
| + | {{hr - 2}} | ||
| + | |||
| + | ==Users== | ||
* [[API List Users|List Users]] | * [[API List Users|List Users]] | ||
* [[API User Details|User Details]] | * [[API User Details|User Details]] | ||
| Line 23: | Line 31: | ||
* [[API Update User|Update User]] | * [[API Update User|Update User]] | ||
* [[API Delete User|Delete User]] | * [[API Delete User|Delete User]] | ||
| − | + | ||
| + | {{hr - 2}} | ||
| + | |||
| + | ==Templates== | ||
* [[API Templates|Default Templates]] | * [[API Templates|Default Templates]] | ||
* [[API List Templates|List Templates]] | * [[API List Templates|List Templates]] | ||
| Line 35: | Line 46: | ||
* [[API Remove Template Fields|Remove Template Fields]] | * [[API Remove Template Fields|Remove Template Fields]] | ||
| − | + | {{hr - 2}} | |
| + | |||
| + | ==Rooms== | ||
* [[API List Rooms|List Rooms]] | * [[API List Rooms|List Rooms]] | ||
* [[API Room Details|Room Details]] | * [[API Room Details|Room Details]] | ||
| Line 46: | Line 59: | ||
* [[API Delete Marker|Delete Marker]] | * [[API Delete Marker|Delete Marker]] | ||
| − | + | ||
| + | {{Top of Page}} | ||
| + | {{hr - 2}} | ||
| + | |||
| + | ==Cameras== | ||
* [[API List Cameras|List Cameras]] | * [[API List Cameras|List Cameras]] | ||
* [[API Camera Details|Camera Details]] | * [[API Camera Details|Camera Details]] | ||
| Line 52: | Line 69: | ||
* [[API Update Camera|Update Camera]] | * [[API Update Camera|Update Camera]] | ||
* [[API Delete Camera|Delete Camera]] | * [[API Delete Camera|Delete Camera]] | ||
| − | + | ||
| + | |||
| + | {{Top of Page}} | ||
| + | {{hr}} | ||
| + | |||
| + | =Room Control= | ||
* [[API Room Details|Room Details]] | * [[API Room Details|Room Details]] | ||
* [[API Room Status|Room Status]] | * [[API Room Status|Room Status]] | ||
| Line 61: | Line 83: | ||
* [[API Lock Room|Lock Room]] | * [[API Lock Room|Lock Room]] | ||
* [[API Unlock Room|Unlock Room]] | * [[API Unlock Room|Unlock Room]] | ||
| − | + | ||
| + | |||
| + | {{Top of Page}} | ||
| + | {{hr}} | ||
| + | |||
| + | =Markers (VALT 5.X)= | ||
* [[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 | + | |
| + | |||
| + | {{Top of Page}} | ||
| + | {{hr}} | ||
| + | |||
| + | =Comments (VALT 6.x)= | ||
| + | * [[API List Comments|List Comments]] | ||
| + | * [[API Add Comment|Add Comment]] | ||
| + | * [[API Edit Comment|Edit Comment]] | ||
| + | * [[API Delete Comment|Delete Comment]] | ||
| + | |||
| + | |||
| + | {{Top of Page}} | ||
| + | {{hr}} | ||
| + | |||
| + | =Recorded Videos= | ||
* [[API List Recordings|List Recordings]] | * [[API List Recordings|List Recordings]] | ||
* [[API Recording Details|Recording Details]] | * [[API Recording Details|Recording Details]] | ||
| Line 74: | 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]] | ||
| Line 79: | Line 123: | ||
* [[API Delete Marker|Delete Marker]] | * [[API Delete Marker|Delete Marker]] | ||
| − | + | ||
| + | {{Top of Page}} | ||
| + | {{hr}} | ||
| + | |||
| + | =Filters= | ||
* [[API List Filters|List Filters]] | * [[API List Filters|List Filters]] | ||
* [[API Filter Details|Filter Details]] | * [[API Filter Details|Filter Details]] | ||
| Line 86: | Line 134: | ||
* [[API Update Filter|Update Filter]] | * [[API Update Filter|Update Filter]] | ||
* [[API Delete Filter|Delete Filter]] | * [[API Delete Filter|Delete Filter]] | ||
| − | + | ||
| + | |||
| + | {{Top of Page}} | ||
| + | {{hr}} | ||
| + | |||
| + | =Schedules= | ||
* [[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 95: | Line 148: | ||
* [[API Delete Next Instance|Delete Next Instance]] | * [[API Delete Next Instance|Delete Next Instance]] | ||
* [[API Stop Schedule|Stop Schedule]] | * [[API Stop Schedule|Stop Schedule]] | ||
| + | |||
| + | |||
| + | {{Top of Page}} | ||
| + | }} | ||
| + | [[Category:VALT]] | ||
Latest revision as of 14:08, 28 May 2025
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
- Default Templates
- List Templates
- Template Details
- Create Template
- Update Template
- Delete Template
- List Template Fields
- Add Template Fields
- Update Template Fields
- Remove Template Fields
Rooms
- List Rooms
- Room Details
- Create Room
- Update Room
- Delete Room
- List Cameras in Room
- Add Marker
- Edit Marker
- Delete Marker
Cameras
Room Control
- Room Details
- Room Status
- Start Recording
- Stop Recording
- Pause Recording
- Resume Recording
- Lock Room
- Unlock Room
Markers (VALT 5.X)
Comments (VALT 6.x)
Recorded Videos
- List Recordings
- Recording Details
- Change Recording
- Create Clip
- Delete Recording
- Create Sharing Link
- Remove Sharing Link
- Download Recording Video
- Upload Recording
- List Markers
- Add Marker
- Edit Marker
- Delete Marker
Filters
Schedules
- List Schedules
- List Schedule Conflicts
- Schedule Details
- Create Schedule
- Update Schedule
- Delete Schedule
- Delete Next Instance
- Stop Schedule
