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/trigger	GET	Automation	Access to Automation
/api/accesspoint/blocking/ctrl	GET/POST	Access Control	Access Control – Control
/api/accesspoint/blocking/status	GET/POST	Access Control	Access Control – Monitoring
/api/accesspoint/grantaccess	GET/POST	Access Control	Access Control – Control
/api/audio/test	GET/POST	Audio	Audio – Control
/api/call/answer	GET/POST	Phone/Call	Phone/Calls – Control
/api/call/dial	GET/POST	Phone/Call	Phone/Calls – Control
/api/call/hangup	GET/POST	Phone/Call	Phone/Calls – Control
/api/call/status	GET/POST	Phone/Call	Phone/Calls – Monitoring
/api/camera/caps	GET/POST	Camera	Camera – Monitoring
/api/camera/snapshot	GET/POST	Camera	Camera – Monitoring
/api/config	GET/POST/PUT	System	System – Control
/api/config/factoryreset	GET/POST	System	System – Control
/api/config/holidays	GET/PUT	System	System – Control
/api/dir/create	PUT	System	System – Control
/api/dir/delete	PUT	System	System – Control
/api/dir/get	POST	System	System – Control
/api/dir/query	POST	System	System – Control
/api/dir/template	GET/POST	System	System – Control
/api/dir/update	PUT	System	System – Control
/api/display/caps	GET/POST	Display	Display – Control
/api/display/image	PUT/DELETE	Display	Display – Control
/api/email/send	GET/POST	E-mail	E-mail – Control
/api/firmware	PUT	System	System – Control
/api/firmware/apply	GET/POST	System	System – Control
/api/firmware/reject	GET/POST	System	System – Control
/api/holidays	GET/PUT	System	System – Control
/api/io/caps	GET/POST	I/O	Inputs and outputs – Monitoring
/api/io/ctrl	GET/POST	I/O	Inputs and outputs – Monitoring
/api/io/status	GET/POST	I/O	Inputs and outputs – Monitoring
/api/lift/grantaccess	GET/POST	Access Control	Access Control – Control
/api/log/caps	GET/POST	Logging	–
/api/log/pull	GET/POST	Logging	–
/api/log/subscribe	GET/POST	Logging	*
/api/log/unsubscribe	GET/POST	Logging	*
/api/lpr/image	GET/POST	Access Control	Access Control – Monitoring
/api/lpr/licenseplate	POST	Access Control	Access Control – Control
/api/mobilekey/config	GET/PUT	Access Control	Access Control – Monitoring
/api/pcap	GET/POST	System	System – Control
/api/pcap/live	GET/POST	System	System – Control
/api/pcap/live/stats	GET/POST	System	System – Control
/api/pcap/live/stop	GET/POST	System	System – Control
/api/pcap/restart	GET/POST	System	System – Control
/api/pcap/stop	GET/POST	System	System – Control
/api/phone/calllog	DELETE	Phone/Call	Phone/Calls – Control
/api/phone/calllog	GET/POST	Phone/Call	Phone/Calls – Monitoring
/api/phone/status	GET/POST	Phone/Call	Phone/Calls – Monitoring
/api/switch/caps	GET/POST	Switch	Switches – Monitoring
/api/switch/ctrl	GET/POST	Switch	Switches – Control
/api/switch/status	GET/POST	Switch	Switches – Monitoring
/api/system/caps	GET	System	System – Monitoring
/api/system/info	GET/POST	System	–
/api/system/restart	GET/POST	System	System – Control
/api/system/status	GET/POST	System	System – Control
/api/system/time	GET/POST/PUT	System	System – Monitoring/Control
/api/system/time/set	GET/POST	System	System – Control
/api/system/timezone	GET/PUT	System	System – Monitoring/Control
/api/system/timezone/caps	GET	System	System – Monitoring
/api/system/ca	GET/PUT/DELETE	System	System – Control
/api/system/user	GET/PUT/DELETE	System	System – Control

This section also includes:

5.1 api system
- 5.1.1 api system info
- 5.1.2 api system status
- 5.1.3 api system restart
- 5.1.4 api system caps
- 5.1.5 api system time
- 5.1.6 api system timezone
- 5.1.7 api system timezone caps
5.2 api firmware
- 5.2.1 api firmware
- 5.2.2 api firmware apply
- 5.2.3 api firmware reject
5.3 api config
- 5.3.1 api config
- 5.3.2 api config factoryreset
- 5.3.3 api config holidays
5.4 api switch
- 5.4.1 api switch caps
- 5.4.2 api switch status
- 5.4.3 api switch ctrl
5.5 api io
- 5.5.1 api io caps
- 5.5.2 api io status
- 5.5.3 api io ctrl
5.6 api phone
- 5.6.1 api phone status
- 5.6.2 api phone calllog
- 5.6.3 api phone config
5.7 api call
- 5.7.1 api call status
- 5.7.2 api call dial
- 5.7.3 api call answer
- 5.7.4 api call hangup
5.8 api camera
- 5.8.1 api camera caps
- 5.8.2 api camera snapshot
5.9 api display
- 5.9.1 api display caps
- 5.9.2 api display image
  - 5.9.2.1 api display image examples
5.10 api log
- 5.10.1 api log caps
- 5.10.2 api log subscribe
- 5.10.3 api log unsubscribe
- 5.10.4 api log pull
5.11 api audio
- 5.11.1 api audio test
5.12 api email
- 5.12.1 api email send
5.13 api pcap
- 5.13.1 api pcap
- 5.13.2 api pcap restart
- 5.13.3 api pcap stop
- 5.13.4 api pcap live
- 5.13.5 api pcap live stop
- 5.13.6 api pcap live stats
5.14 api dir
- 5.14.1 api dir template
- 5.14.2 api dir create
- 5.14.3 api dir update
- 5.14.4 api dir delete
- 5.14.5 api dir get
- 5.14.6 api dir query
5.15 api mobilekey
- 5.15.1 api mobilekey config
5.16 api lpr
- 5.16.1 api lpr licenseplate
- 5.16.2 api lpr image
5.17 api accesspoint blocking
- 5.17.1 api accesspoint blocking ctrl
- 5.17.2 api accesspoint blocking status
- 5.17.3 api accesspoint grantaccess
5.18 api lift
- 5.18.1 api lift grantaccess
5.19 api automation
- 5.19.1 api automation trigger
5.20 api cert
- 5.20.1 api cert ca
- 5.20.2 api cert user