VAPIX , HTTP API Specification - Axis Communications

1 VAPIX , http API Specification Revision: Date: 2007-October-17 TABLE OF CONTENTS DOCUMENT HISTORY 1 OVERVIEW Product and firmware versions 2 REFERENCES 3 DEFINITIONS General notations o General abbreviations o Style convention o General CGI URL syntax and parameters o Parameter value convention 4 INTERFACE Specification Naming conventions and URL syntax o Obsolete CGI parameters Server responses o http status codes 5 API GROUPS General o Add, update, remove and list parameters and their values List parameters List output format Update parameters Add parameters Remove parameters Add/Remove server responses o Add.

2 Modify and delete users o Factory default o Hard factory default o Backup o Restore o Firmware upgrade o Restart server o Server report o System logs o Access logs o System date and time Get system date and time Set system date and time Image and Video o Image size o Video status o Bitmap Bitmap image request Bitmap image (snapshot) CGI request Bitmap image response o JPEG/MJPG JPEG image request JPEG image (snapshot) CGI request JPEG image response JPEG buffer request MJPG video request MJPG video CGI request MJPG video response o MPEG-4 MPEG-4 SDP description request Restart the MPEG-4 stream MPEG-4 statistics o Dynamic text overlay PTZ o PTZ driver update o PTZ administration o PTZ control o PTZ configuration o Set PTZ parameters o PTZ control queue o PTZ control queue response Motion Detection o Add a Motion Detection window o Remove a Motion Detection window o Update the Motion Detection

3 Parameters o List the Motion detection parameters o Get the Motion Detection level I/O o I/O control Input Output o Virtual I/O control Input Serial port o Serial port control o Open serial port IP filter o IP filter administration o Server responses Audio o Audio MIME types o Audio data request o Singlepart audio data response o Multipart audio data response o Audio data transmit axis 292 Network Video Decoder o Alarm o Video control Connect Disconnect Invalidate Cache Select Source DOCUMENT HISTORY Version Date Comment 2003-Sep-16 Initial version 2004-Feb-03 Added requests for Video status, Bitmap, JPEG buffer, PTZ, Motion Detection, I/O and Serial port.

4 Added new parameters to JPEG image CGI request and MJPG video CGI request. 2004-Feb-16 Added requests for Image overlay. 2004-May-27 Added more valid values for the parameter resolution, to the Bitmap image, JPEG image and MJPG video CGI requests. Added requests for Backup, Restore, Firmware upgrade and IP address filtering. 2004-July-09 Added more valid values for the parameter resolution, to the JPEG image and MJPG video CGI requests. 2004-July-23 Added requests for MPEG-4. 2004-Nov-03 Added requests for Audio. Added responseformat parameter to 2005-Feb-25 Removed the nosync parameter from Added reference to the RTSP API for controlling MPEG-4 streams.

5 The MPEG-4 SDP description request have been changed to The previous will still be supported. 2005-May-26 Added a policy parameter for the and examples. Added new http APIs for the axis 292 Network Video Decoder. 2005-Oct-26 Added example to list parameters using wildcards. Added the parameter "range" to the JPEG buffer request. Added example to pulse the virtual input. Moved PTZ preset position configuration from to Added for OSD menu control. Updated information about the PTZ control queue response. 2007-Jan-11 Added force parameter to Added explanations for digital PTZ.

6 Added areazoom parameter to Added timezone parameter to Corrected some examples and added audio transmit examples. 2007-Jan-31 Removed Image overlay APIs. Removed areazoom parameter for , new API will soon be available. 2007-Feb-28 Added areazoom parameter for 2007-June-29 Added Dynamic text overlay. 2007-Oct-17 Added access logs. 1 OVERVIEW This document specifies the external http -based application programming interface of the axis camera and video servers with firmware version and above. The http -based video interface provides the functionality for requesting single and multi-part images and for getting and setting internal parameter values.

7 The image and CGI-requests are handled by the built-in Web server in the camera and video servers. Product and firmware versions The support for the http API is product and firmware dependent. Please refer to the Release Notes for the actual product for compliance information. 2 REFERENCES http protocol Hypertext Transfer Protocol -- External application programming interfaces (Client side) VAPIX , http API Specification VAPIX , RTSP API Specification axis Video Product Release Notes VAPIX , Parameter Specification 3 DEFINITIONS This section contains information on general usage of this document.

8 General notation General abbreviations The following abbreviations are used throughout this document CGI Common Gateway Interface - a standardized method of communication between a client ( a web browser) and a server ( a web server). TBD To be done/designed - signifies that the referenced section/subsection/entity is intended to be specified, but has not reached a level of maturity to be public at this time. N/A Not applicable - a feature/parameter/value is of no use in a specific task URL RFC 1738 describes the syntax and semantics for a compact string representation for a resource available via the Internet.

9 These strings are called "Uniform Resource Locators" (URLs). URI A Uniform Resource Identifier (URI) is a compact string of characters for identifying an abstract or physical resource. RFC 2396 describes the generic syntax of URI. Style convention In URL syntax and in descriptions of CGI parameters, text in italics within angle brackets denotes content that should be replaced with either a value or a string. When replacing the text string, the angle brackets must also be replaced. An example of this is the description of the name for the server, denoted with <servername> in the URL syntax description below, which is replaced with the string myserver in the URL syntax example, also shown below.

10 URL syntax is written with the word "Syntax:" shown in bold face, followed by a box with the referred syntax, as shown below. The name of the server is written as <servername>. This is intended to be replaced with the name of the actual server. This can either be a name, "thecam" or " " or the associated IP number for the server, Syntax: http ://<servername>/ A description of returned data is written with "Return:" in bold face, followed by the returned data in a box. All data returned as http -formatted, starting with the string http , is line-separated with a Carriage Return and Line Feed (CRLF) printed as \r\n.