Summary of HMP REST API Resources | Haivision InfoCenter

REST API Endpoint	Method	Use to…
/apis/authentication/login	GET POST DELETE	(4.1) Get User Session Info (4.1) Initiate User Session (4.1) Delete a User Session
/apis/users/enabled	GET	(4.1) Get the User List
/apis/groups/enabled	GET	(4.1) Get the Group List
/apis/sources	GET POST	(4.1) Get the Source Lis (4.1) Create a Source
/apis/sources/:sourceId	GET PUT DELETE	(4.1) Get Information on a Source (4.1) Edit a Source (4.1) Delete a Source
/apis/sources/:sourceId/metadata	GET PUT DELETE	(4.1) Get a List of Metadata (4.1) Edit Source Metadata (4.1) Delete Source Metadata
/apis/sources/:sourceId/shares	GET POST	(4.1) View Sharing Permissions for a Source (4.1) Create Share Permissions for a Source
/apis/sources/:sourceId/shares/:shareId	GET PUT DELETE	(4.1) Get Share Permission Information (4.1) Edit Share Permissions (4.1) Delete Share Permissions
/apis/sources/:sourceId/thumbnail	GET	(4.1) Get a Video Thumbnail
/apis/sessions	GET POST	(4.1) Get a List of Sessions Create a Session
/apis/sessions/:sessionId	GET PUT DELETE	(4.1) Get Session Information Edit a Session Delete a Session
/apis/sessions/:sessionId/assets	GET	(4.1) Get a List of Videos from a Session
/apis/sessions/:sessionId/metadata	GET PUT DELETE	(4.1) Get a List of Session Metadata (4.1) Edit Session Metadata (4.1) Delete Session Metadata
/apis/sessions/:sessionId/shares	GET POST	(4.1) Get Share Permissions for a Session (4.1) Create Share Permissions for a Session
/apis/sessions/:sessionId/shares/:shareId	GET PUT DELETE	(4.1) Get Share Permission Information for a Session (4.1) Edit Share Permission for a Session (4.1) Delete Share Permission for a Session
/apis/sessions/:sessionId/sources	GET	(4.1) List Session Sources (4.1) Add a Session Source
/apis/sessions/:sessionId/sources/:sourceId	DELETE	(4.1) Delete Session Sources
/apis/sessions/:sessionId/recordings	GET POST	(4.1) Get a List of Active Recordings for a Session (4.1) Create a New Recording Session
/apis/sessions/:sessionId/thumbnail	GET	(4.1) Get Thumbnail Image for a Session
/apis/sessions/:sessionId/publicshare	GET POST DELETE	(4.1) Get a List of Public Shares (4.1) Create a Public Share (4.1) Delete Public Share
/apis/sessions/:sessionId/events	GET POST	(4.1) Get a Session's Event List (4.1) Create a Session Event
/apis/sessions/:sessionId/events/:eventId	GET PUT	(4.1) Get Event Information for a Session (4.1) Edit a Session Event
/apis/recordings	GET	(4.1) Get a List of Active Recordings
/apis/recordings/:recordingId	GET PUT DELETE	(4.1) Get Recording Details (4.1) Pause or Resume a Recording (4.1) Stop a Recording
/apis/recordings/:recordingId/hotmarks	POST	(4.1) Create a HotMark on a Recording
/apis/categories	GET	(4.1) Get a List of Categories
/apis/categories/:categoryId	GET	(4.1) Get Category Details
/apis/assets	GET	(4.1) Get a List of Recorded Videos
/apis/assets/:assetId	GET PUT DELETE	(4.1) Get Video Details (4.1) Update a Title or Description (4.1) Delete a Video
/apis/assets/:assetId/metadata	GET PUT DELETE	(4.1) Get Video Metadata (4.1) Edit Video Metadata (4.1) Delete Video Metadata
/apis/assets/:assetId/related	GET	(4.1) Get List of Related Videos
/apis/assets/:assetId/shares	GET POST	(4.1) Get Video Sharing Permission Information (4.1) Create Video Share Permissions
/apis/assets/:assetId/shares/:shareId	GET PUT DELETE	(4.1) Get Video Share Permissions (4.1) Edit Video Share Permissions (4.1) Delete Video Share Permissions
/apis/assets/:assetId/hotmarks	GET POST	(4.1) Get a List of HotMarks (4.1) Create a New HotMark
/apis/assets/:assetId/hotmarks/:hotmarkId	GET PUT DELETE	(4.1) Get Specific HotMark Information (4.1) Update a Hotmark (4.1) Delete a HotMark
/apis/assets/:assetId/download	GET	(4.1) Download Videos
/apis/assets/:assetId/streams	GET POST	(4.1) Get a Stream List Started from a Video (4.1) Create a Stream
/apis/assets/:assetId/streams/:streamId	GET DELETE	(4.1) Get Stream Information for a Video (4.1) Delete a Stream for a Video
/apis/assets/:assetId/thumbnail	GET PUT	(4.1) Get a Thumbnail Image for a Video (4.1) Update the Thumbnail for a Video
/apis/assets/:assetId/tracks/:trackId/thumbnail	GET	(4.1) Get a Thumbnail Image for a Video Track
/apis/assets/:assetId/publicshare	GET POST DELETE	(4.1) Get a Public Share List for a Video (4.1) Create a Public Share for a Video (4.1) Delete a Public Share for a Video
/apis/sections	GET	(4.1) Get a List of Feeds
/apis/sections/:sectionId	GET	(4.1) Get Feed Information
/apis/sections/content	GET	(4.1) Get a List of Content in All Feeds
/apis/sections/:sectionId/content	GET	(4.1) Get a List of Content in a Feed
/apis/sections/:sectionId/assets	GET	(4.1) Get a List of Assets in a Feed
/apis/sections/:sectionId/sessions	GET	(4.1) Get a List of Sessions in a Feed
/apis/sections/:sectionId/sources	GET	(4.1) Get a List of Sources in a Feed
/apis/sections/:sectionId/shares	GET POST	(4.1) Get Share Permissions for a Feed (4.1) Create Share Permissions for a Feed
/apis/sections/:sectionId/shares/:shareId	GET PUT DELETE	(4.1) Get Share Permission Information for a Feed (4.1) Edit Share Permission for a Feed (4.1) Delete Share Permission for a Feed
/apis/streams	GET	(4.1) Get a Stream List Started from a Video
/apis/streams/:streamId	GET PUT DELETE	(4.1) Get Stream Information (4.1) Pause or Resume a Stream (4.1) Stop a Stream
/apis/streams/:streamId/seek	POST	(4.1) Jump to a Point in a Stream
/apis/system/version	GET	(4.1) Get the HMP Software/Build Version
/apis/events	GET	(4.1) Get List of All Events
/apis/devices/stbs	GET	(4.1) Get List of Devices
/apis/devices/stbs/:stbId	GET	(4.1) Get Device Information
/apis/devices/tags	GET	(4.1) Get Device Tags
/apis/devices/stbs/:stbId/command	POST	(4.1) Send an STB Command