Difference between revisions of "VALT API"
IVSWikiBlue (talk | contribs) |
IVSWikiBlue (talk | contribs) |
||
| (3 intermediate revisions by the same user not shown) | |||
| Line 1: | Line 1: | ||
__TOC__ | __TOC__ | ||
| − | |||
| − | |||
{{Aside | hue = 50 | icon = ⚠ | content = <b>IMPORTANT:</b> An Enterprise license is required to leverage the VALT API.}} | {{Aside | hue = 50 | icon = ⚠ | content = <b>IMPORTANT:</b> An Enterprise license is required to leverage the VALT API.}} | ||
| − | + | {{Article | 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== | ==Authentication== | ||
*[[API Authentication|Authentication]] | *[[API Authentication|Authentication]] | ||
| + | {{hr}} | ||
==Administration== | ==Administration== | ||
* [[API Application Information|Application Information]] | * [[API Application Information|Application Information]] | ||
| Line 11: | Line 12: | ||
* [[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=== | ===User Groups=== | ||
* [[API List User Groups|List User Groups]] | * [[API List User Groups|List User Groups]] | ||
| Line 17: | Line 19: | ||
* [[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=== | ===Users=== | ||
* [[API List Users|List Users]] | * [[API List Users|List Users]] | ||
| Line 23: | Line 26: | ||
* [[API Update User|Update User]] | * [[API Update User|Update User]] | ||
* [[API Delete User|Delete User]] | * [[API Delete User|Delete User]] | ||
| + | {{hr - 2}} | ||
===Templates=== | ===Templates=== | ||
* [[API Templates|Default Templates]] | * [[API Templates|Default Templates]] | ||
| Line 34: | Line 38: | ||
* [[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]] | ||
| − | + | {{hr - 2}} | |
===Rooms=== | ===Rooms=== | ||
* [[API List Rooms|List Rooms]] | * [[API List Rooms|List Rooms]] | ||
| Line 45: | Line 49: | ||
* [[API Edit Marker|Edit Marker]] | * [[API Edit Marker|Edit Marker]] | ||
* [[API Delete Marker|Delete Marker]] | * [[API Delete Marker|Delete Marker]] | ||
| − | + | {{hr - 2}} | |
===Cameras=== | ===Cameras=== | ||
* [[API List Cameras|List Cameras]] | * [[API List Cameras|List Cameras]] | ||
| Line 52: | Line 56: | ||
* [[API Update Camera|Update Camera]] | * [[API Update Camera|Update Camera]] | ||
* [[API Delete Camera|Delete Camera]] | * [[API Delete Camera|Delete Camera]] | ||
| + | {{hr}} | ||
==Room Control== | ==Room Control== | ||
* [[API Room Details|Room Details]] | * [[API Room Details|Room Details]] | ||
| Line 61: | Line 66: | ||
* [[API Lock Room|Lock Room]] | * [[API Lock Room|Lock Room]] | ||
* [[API Unlock Room|Unlock Room]] | * [[API Unlock Room|Unlock Room]] | ||
| − | ==Markers== | + | {{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]] | ||
| + | {{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]] | ||
| + | {{hr}} | ||
==Recorded Videos== | ==Recorded Videos== | ||
* [[API List Recordings|List Recordings]] | * [[API List Recordings|List Recordings]] | ||
| Line 78: | Line 91: | ||
* [[API Edit Marker|Edit Marker]] | * [[API Edit Marker|Edit Marker]] | ||
* [[API Delete Marker|Delete Marker]] | * [[API Delete Marker|Delete Marker]] | ||
| − | + | {{hr}} | |
==Filters== | ==Filters== | ||
* [[API List Filters|List Filters]] | * [[API List Filters|List Filters]] | ||
| Line 86: | Line 99: | ||
* [[API Update Filter|Update Filter]] | * [[API Update Filter|Update Filter]] | ||
* [[API Delete Filter|Delete Filter]] | * [[API Delete Filter|Delete Filter]] | ||
| + | {{hr}} | ||
==Schedules== | ==Schedules== | ||
* [[API List Schedules|List Schedules]] | * [[API List Schedules|List Schedules]] | ||
| Line 95: | Line 109: | ||
* [[API Delete Next Instance|Delete Next Instance]] | * [[API Delete Next Instance|Delete Next Instance]] | ||
* [[API Stop Schedule|Stop Schedule]] | * [[API Stop Schedule|Stop Schedule]] | ||
| + | }} | ||
Latest revision as of 09:35, 9 October 2024
Contents
⚠IMPORTANT: An Enterprise license is required to leverage the VALT API.
VALT API
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
- List Markers
- Add Marker
- Edit Marker
- Delete Marker
