Skip to content
DEVELOPER FORUM
Search
API
/
VENUS API
WebAPI.Host
(3.0)
Download OpenAPI description
openapi.json
openapi.yaml
Languages
Servers
Mock server
https://{{your_venus_webapi_ip_address}}/
Cameras
Operations
get
/api/vector/v3/cameras/enabled
get
/api/vector/v3/cameras/metadata
get
/api/vector/v3/cameras/stream
get
/api/vector/v3/cameras/export-stream
get
/api/vector/v3/cameras/image
post
/api/vector/v3/cameras/start
post
/api/vector/v3/cameras/stop
post
/api/vector/v3/cameras/bookmark
+ Show
Devices
Operations
get
/api/vector/v3/devices/deck-layout/{deviceId}
post
/api/vector/v3/devices/instrument-configuration
get
/api/vector/v3/devices/registered
get
/api/vector/v3/devices/runtime
post
/api/vector/v3/devices/control-panel/runtime
post
/api/vector/v3/devices/control-panel/registered
+ Show
ErrorHandler
Operations
post
/api/vector/v3/error-handler
delete
/api/vector/v3/error-handler
get
/api/vector/v3/error-handler
get
/api/vector/v3/instrument-errors/unhandled
post
/api/vector/v3/instrument-errors/{uuid}/recovery
post
/api/vector/v3/instrument-errors/{uuid}/action
+ Show
Files
Operations
get
/api/vector/v3/files/validation
post
/api/vector/v3/files/export-method
post
/api/vector/v3/files/export-methods
post
/api/vector/v3/files/export-method-package
post
/api/vector/v3/files/import-method
post
/api/vector/v3/files/import-methods
post
/api/vector/v3/files/import-method-package
post
/api/vector/v3/files/verify-manifest
Show 9 more...
+ Show
InstrumentData
Operations
get
/api/vector/v3/instrumentdata
post
/api/vector/v3/instrumentdata
put
/api/vector/v3/instrumentdata/{instrumentId}
delete
/api/vector/v3/instrumentdata/{instrumentId}
+ Show
RunExecutor
Operations
post
/api/vector/v3/execution/analyze
post
/api/vector/v3/execution/analyze-method-package
put
/api/vector/v3/execution/load
put
/api/vector/v3/execution/input
post
/api/vector/v3/execution/start
post
/api/vector/v3/execution/pause
post
/api/vector/v3/execution/resume
post
/api/vector/v3/execution/abort
Show 5 more...
+ Show
System
Operations
get
/api/vector/v3/system/authentication-mode
get
/api/vector/v3/system/paths
head
/api/vector/v3/system/paths
get
/api/vector/v3/system/venus/version
head
/api/vector/v3/system/venus/version
post
/api/vector/v3/system/venus/archive
post
/api/vector/v3/system/invalidate-run-history-cache
put
/api/vector/v3/system/configuration/simulation
Show 1 more...
+ Show
Users
Operations
get
/api/vector/v3/users/logon
get
/api/vector/v3/users/display-name
get
/api/vector/v3/users/session-state
+ Show