5. Overview of HTTP API Functions

The table below provides a list of all available HTTP API functions including:

  • the HTTP request absolute path;
  • the supported HTTP methods;
  • the service in which the function is included;
  • the required user privileges (if authentication is used);
  • the use of the selected function is not subject to license in versions FW 2.35 and higher (i.e. the function is avalaible without entering the license key)

Absolute path

Method

Service

Privileges

/api/automation/triggerGETAutomationAccess to Automation
/api/accesspoint/blocking/ctrlGET/POSTAccess ControlAccess Control – Control
/api/accesspoint/blocking/statusGET/POSTAccess ControlAccess Control – Monitoring
/api/accesspoint/grantaccessGET/POSTAccess ControlAccess Control – Control
/api/audio/testGET/POSTAudioAudio – Control
/api/call/answerGET/POSTPhone/CallPhone/Calls – Control
/api/call/dialGET/POSTPhone/CallPhone/Calls – Control
/api/call/hangupGET/POSTPhone/CallPhone/Calls – Control
/api/call/statusGET/POSTPhone/CallPhone/Calls – Monitoring
/api/camera/capsGET/POSTCameraCamera – Monitoring
/api/camera/snapshotGET/POSTCameraCamera – Monitoring
/api/configGET/POST/PUTSystemSystem – Control
/api/config/factoryresetGET/POSTSystemSystem – Control
/api/config/holidaysGET/PUTSystemSystem – Control
/api/dir/createPUTSystemSystem – Control
/api/dir/deletePUTSystemSystem – Control
/api/dir/getPOSTSystemSystem – Control
/api/dir/query POSTSystemSystem – Control
/api/dir/templateGET/POSTSystemSystem – Control
/api/dir/updatePUTSystemSystem – Control
/api/display/capsGET/POSTDisplayDisplay – Control
/api/display/imagePUT/DELETEDisplayDisplay – Control
/api/email/sendGET/POSTE-mailE-mail – Control
/api/firmwarePUTSystemSystem – Control
/api/firmware/applyGET/POSTSystemSystem – Control
/api/firmware/rejectGET/POSTSystemSystem – Control
/api/holidaysGET/PUTSystemSystem – Control
/api/io/capsGET/POSTI/OInputs and outputs – Monitoring
/api/io/ctrlGET/POSTI/OInputs and outputs – Monitoring
/api/io/statusGET/POSTI/OInputs and outputs – Monitoring
/api/lift/grantaccessGET/POSTAccess ControlAccess Control – Control
/api/log/capsGET/POSTLogging
/api/log/pullGET/POSTLogging
/api/log/subscribeGET/POSTLogging*
/api/log/unsubscribeGET/POSTLogging*
/api/lpr/imageGET/POSTAccess ControlAccess Control – Monitoring
/api/lpr/licenseplatePOSTAccess ControlAccess Control – Control
/api/mobilekey/configGET/PUTAccess ControlAccess Control – Monitoring
/api/pcapGET/POSTSystemSystem – Control
/api/pcap/liveGET/POSTSystemSystem – Control
/api/pcap/live/statsGET/POSTSystemSystem – Control
/api/pcap/live/stopGET/POSTSystemSystem – Control
/api/pcap/restartGET/POSTSystemSystem – Control
/api/pcap/stopGET/POSTSystemSystem – Control
/api/phone/calllogDELETEPhone/CallPhone/Calls – Control
/api/phone/calllogGET/POSTPhone/CallPhone/Calls – Monitoring
/api/phone/statusGET/POSTPhone/CallPhone/Calls – Monitoring
/api/switch/capsGET/POSTSwitchSwitches – Monitoring
/api/switch/ctrlGET/POSTSwitchSwitches – Control
/api/switch/statusGET/POSTSwitchSwitches – Monitoring
/api/system/capsGETSystemSystem – Monitoring
/api/system/infoGET/POSTSystem
/api/system/restartGET/POSTSystemSystem – Control
/api/system/statusGET/POSTSystemSystem – Control
/api/system/timeGET/POSTSystem System – Monitoring
/api/system/time/setGET/POSTSystemSystem – Control
/api/system/caGET/PUT/DELETESystemSystem – Control
/api/system/userGET/PUT/DELETESystemSystem – Control

This section also includes: