End User Licenses Agreement (EULA)

External IP Device Information

Description

The External IP Device Information API features the steps that makes it possible to store information that can then be used to access an external IP device, which in the context of this API is a unit capable of generating data streams, such as a network camera. Stored information can be used to set up communications with the IP device, which is useful when an Axis Network Video Recorder is pulling videos from multiple camera sources.

Model

The API implements externalipdeviceinfo as its communications interface and supports the following CGI methods accessed using either HTTP GET or HTTP POST:

MethodDescriptionLatest ver.
create.cgiCreates an external IP device.2.1
update.cgiUpdates an external IP device.2.1
delete.cgiRemoves an external IP device.2.0
list.cgiLists created external IP devices.2.1
geteventsenabled.cgiRetrieves the enable status for events on external IP devices.2.0
seteventsenabled.cgiEnables or disables events on external IP devices.2.0
getcacertificates.cgiRetrieves CA certificates for validation.2.1
setcacertificates.cgiSets up CA certificates for validation.2.1
schemaversions.cgiRetrieves XML schema versions supported by your product.2.0

Identification

API Discovery

id=ext-ip-dev-info

Common examples

Configure a network recorder for camera motion events

Use this example to configure a network recorder to pull a video when a motion event in the camera is triggered. Please note that the camera needs to support and have motion detection enabled.

1. Create two external IP devices.

Device 1
http://<myserver>/axis-cgi/externalipdeviceinfo/create.cgi?schemaversion=2&id=example-id_123&address=192.168.0.123&username=device1&password=pass1&description="Exampleextipdev"&serialnumber=AABBCCDDEEFF1234
Device 2
http://<myserver>/axis-cgi/externalipdeviceinfo/create.cgi?schemaversion=2&id=example-id_124&address=fe80::aecc:8eff:fee3:64fd&username=device2&password=pass2&description="Second example extipdev"&serialnumber=AABBCCDDEEFF5678

2. Parse the XML response, which will result in either the successful creation of an external IP device or an error. In this example, the error appeared because the id parameter was not supplied.

Successful response example
<?xml version="1.0" encoding="UTF-8"?>
<DeviceResponse SchemaVersion="2.1" xmlns:xsi="http://www.w3.org/2001/XMLSchema-instance" xsi:noNamespaceSchemaLocation="http://www.axis.com/vapix/http_cgi/ExternalIpDeviceInfo2.xsd">
  <GeneralSuccess/>
</DeviceResponse>
Error response example
<?xml version="1.0" encoding="UTF-8"?>
<DeviceResponse SchemaVersion="2.1" xmlns:xsi="http://www.w3.org/2001/XMLSchema-instance" xsi:noNamespaceSchemaLocation="http://www.axis.com/vapix/http_cgi/ExternalIpDeviceInfo2.xsd">
  <GeneralError>
    <ErrorCode>40</ErrorCode>
    <Description>Invalid or no id</Description>
  </GeneralError>
</DeviceResponse>

3. List external IP devices to verify that your devices were created with the correct parameters.

http://<myserver>/axis-cgi/externalipdeviceinfo/list.cgi?schemaversion=2

4. Parse the response.

Successful response example
<?xml version="1.0" encoding="UTF-8"?>
<DeviceResponse SchemaVersion="2.1 xmlns:xsi="http://www.w3.org/2001/XMLSchema-instance" xsi:noNamespaceSchemaLocation="http://www.axis.com/vapix/http_cgi/ExternalIpDeviceInfo2.xsd">
<ListDevicesSuccess>
  <Device>
    <Id>example-id_123</Id>
    <Serialnumber>AABBCCDDEEFF1234</Serialnumber>
    <Description>Example extipdev</Description>
    <Address>192.168.0.123</Address>
    <Username>device1</Username>
    <Protocol>rtspt</Protocol>
    <Port>0</Port>
    <CertificateValidation>off</CertificateValidation>
  </Device>
  <Device>
    <Id>example-id_124</Id>
    <Serialnumber>AABBCCDDEEFF5678</Serialnumber>
    <Description>Second example extipdev</Description>
    <Address>fe80::aecc:8eff:fee3:64fd</Address>
    <Username>device2</Username>
    <Protocol>rtspt</Protocol>
    <Port>0</Port>
    <CertificateValidation>off</CertificateValidation>
  </Device>
  <Device>
    ...
  <Device/>
<ListDevicesSuccess>
</DeviceResponse>
Error response example
<?xml version="1.0" encoding="UTF-8"?>
<DeviceResponse SchemaVersion="2.1" xmlns:xsi="http://www.w3.org/2001/XMLSchema-instance" xsi:noNamespaceSchemaLocation="http://www.axis.com/vapix/http_cgi/ExternalIpDeviceInfo2.xsd">
  <GeneralError>
    <ErrorCode>10</ErrorCode>
    <Description>An error occurred at system level</Description>
  </GeneralError>
</DeviceResponse>

5. Enable events for the external IP device example-id_123. At this stage the stored ID credentials will be used to connect to the camera and retrieve the events.

http://<myserver>/axis-cgi/externalipdeviceinfo/seteventsenabled.cgi?schemaversion=2&id=example-id_123&enabled=yes

6. Parse the XML response.

Successful response example
<?xml version="1.0" encoding="UTF-8"?>
<DeviceResponse SchemaVersion="2.1" xmlns:xsi="http://www.w3.org/2001/XMLSchema-instance" xsi:noNamespaceSchemaLocation="http://www.axis.com/vapix/http_cgi/ExternalIpDeviceInfo2.xsd">
  <GeneralSuccess/>
<DeviceResponse>
Error response example
<?xml version="1.0" encoding="UTF-8"?>
<DeviceResponse SchemaVersion="2.1" xmlns:xsi="http://www.w3.org/2001/XMLSchema-instance" xsi:noNamespaceSchemaLocation="http://www.axis.com/vapix/http_cgi/ExternalIpDeviceInfo2.xsd">
  <GeneralError>
    <ErrorCode>40</ErrorCode>
    <Description>Invalid or no id</Description>
  </GeneralError>
</DeviceResponse>

7. Check if the events were enabled.

http://<myserver>/axis-cgi/externalipdeviceinfo/geteventsenabled.cgi?schemaversion=2&id=example-id_123

8. Parse the XML response.

Successful response example
<DeviceResponse SchemaVersion="2.1" xmlns:xsi="http://www.w3.org/2001/XMLSchema-instance" xsi:noNamespaceSchemaLocation="http://www.axis.com/vapix/http_cgi/ExternalIpDeviceInfo2.xsd">
  <GetEventsEnabledSuccess>
    <Id>example-id_123</Id>
    <EventsEnabled>YES</EventsEnabled>
  </GetEventsEnabledSuccess>
<DeviceResponse>
Error response example
<?xml version="1.0" encoding="UTF-8"?>
<DeviceResponse SchemaVersion="2.1" xmlns:xsi="http://www.w3.org/2001/XMLSchema-instance" xsi:noNamespaceSchemaLocation="http://www.axis.com/vapix/http_cgi/ExternalIpDeviceInfo2.xsd">
  <GeneralError>
    <ErrorCode>40</ErrorCode>
    <Description>Invalid or no id</Description>
  </GeneralError>
</DeviceResponse>

API specifications

create.cgi

list.cgi

seteventsenabled.cgi

geteventsenabled.cgi

Enable certificate validation for a network recorder on a pre-existing motion event recording

Use this example to change a network recorder configuration and pull a video from an encrypted link using certificate validation.

1. Configure two CA certificates for validation. The validation will succeed if the signature is verified by at least one of the certificates. The following example shows separate CA certificates used on different cameras.

http://<myserver>/axis-cgi/externalipdeviceinfo/setcacertificates.cgi?schemaversion=2&certids=caid1,caid2

2. Parse the XML response

Successful response example
<?xml version="1.0" encoding="UTF-8"?>
<DeviceResponse SchemaVersion="2.1" xmlns:xsi="http://www.w3.org/2001/XMLSchema-instance" xsi:noNamespaceSchemaLocation="http://www.axis.com/vapix/http_cgi/ExternalIpDeviceInfo2.xsd">
  <GeneralSuccess/>
</DeviceResponse>
Error response example
<DeviceResponse SchemaVersion="2.1" xmlns:xsi="http://www.w3.org/2001/XMLSchema-instance" xsi:noNamespaceSchemaLocation="http://www.axis.com/vapix/http_cgi/ExternalIpDeviceInfo2.xsd">
  <GeneralError>
    <ErrorCode>[code]</ErrorCode>
    <Description>[description]</Description>
  </GeneralError>
</DeviceResponse>

3. List external IP devices to find out how each network camera is configured. This example contains two cameras that we want to change.

http://<myserver>/axis-cgi/externalipdeviceinfo/list.cgi?schemaversion=2

4. Parse the XML response.

Successful response example
<?xml version="1.0" encoding="UTF-8"?>
<DeviceResponse SchemaVersion="2.1" xmlns:xsi="http://www.w3.org/2001/XMLSchema-instance" xsi:noNamespaceSchemaLocation="http://www.axis.com/vapix/http_cgi/ExternalIpDeviceInfo2.xsd">
<ListDevicesSuccess>
  <Device>
    <Id>example-id_123</Id>
    <Serialnumber>AABBCCDDEEFF1234</Serialnumber>
    <Description>Example extipdev</Description>
    <Address>192.168.0.123</Address>
    <Username>device1</Username>
    <Protocol>rtspt</Protocol>
    <Port>0</Port>
    <CertificateValidation>off</CertificateValidation>
  </Device>
  <Device>
    <Id>example-id_124</Id>
    <Serialnumber>AABBCCDDEEFF5678</Serialnumber>
    <Description>Second example extipdev</Description>
    <Address>fe80::aecc:8eff:fee3:64fd</Address>
    <Username>device2</Username>
    <Protocol>rtspt</Protocol>
    <Port>0</Port>
    <CertificateValidation>off</CertificateValidation>
  </Device>
  <Device>
    ...
  <Device/>
</ListDevicesSuccess>
</DeviceResponse>
Error response example
<?xml version="1.0" encoding="UTF-8"?>
<DeviceResponse SchemaVersion="2.1" xmlns:xsi="http://www.w3.org/2001/XMLSchema-instance" xsi:noNamespaceSchemaLocation="http://www.axis.com/vapix/http_cgi/ExternalIpDeviceInfo2.xsd">
  <GeneralError>
    <ErrorCode>10</ErrorCode>
    <Description>An error occurred at system level</Description>
  </GeneralError>
</DeviceResponse>

5. Update the two devices to use https and certificate validation.

Device 1
http://<myserver>axis-cgi/externalipdeviceinfo/update.cgi?schemaversion=2&id=example-id_123&address=192.168.0.123&username=device1&password=pass1&protocol=rtspsh&certvalidation=standard
Device 2
http://<myserver>/axis-cgi/externalipdeviceinfo/update.cgi?schemaversion=2&id=example-is_124&address=fe80::aecc:8eff:fee3:64fd&username=device2&password=pass2&protocol=rtspsh&port=443&certvalidation=standard

6. Parse the XML response. A successful response means that the external IP device was successfully updated.

Successful response example
<?xml version="1.0" encoding="UTF-8"?>
<DeviceResponse SchemaVersion="2.1" xmlns:xsi="http://www.w3.org/2001/XMLSchema-instance" xsi:noNamespaceSchemaLocation="http://www.axis.com/vapix/http_cgi/ExternalIpDeviceInfo2.xsd">
  <GeneralSuccess/>
</DeviceResponse>

In this example, we show a couple of potential errors. The first one will occur if the protocol is not supported, while the second one will happen if the port number is outside the range of 0 to 65535, and the third one will occur if the certvalidation parameter is set to something other than off/standard/limited.

Error response example
<?xml version="1.0" encoding="UTF-8"?>
<DeviceResponse SchemaVersion="2.1" xmlns:xsi="http://www.w3.org/2001/XMLSchema-instance" xsi:noNamespaceSchemaLocation="http://www.axis.com/vapix/http_cgi/ExternalIpDeviceInfo2.xsd">
  <GeneralError>
    <ErrorCode>190</ErrorCode>
    <Description>Invalid protocol</Description>
  </GeneralError>
</DeviceResponse>
Error response example
<DeviceResponse SchemaVersion="2.1" xmlns:xsi="http://www.w3.org/2001/XMLSchema-instance" xsi:noNamespaceSchemaLocation="http://www.axis.com/vapix/http_cgi/ExternalIpDeviceInfo2.xsd">
  <GeneralError>
    <ErrorCode>200</ErrorCode>
    <Description>Invalid port</Description>
  </GeneralError>
</DeviceResponse>
Error response example
<?xml version="1.0" encoding="UTF-8"?>
<DeviceResponse SchemaVersion="2.1" xmlns:xsi="http://www.w3.org/2001/XMLSchema-instance" xsi:noNamespaceSchemaLocation="http://www.axis.com/vapix/http_cgi/ExternalIpDeviceInfo2.xsd">
  <GeneralError>
    <ErrorCode>210</ErrorCode>
    <Description>Invalid certificate validation</Description>
  </GeneralError>
</DeviceResponse>

7. List the external IP devices to see the changed configuration.

http://<myserver>/axis-cgi/externalipdeviceinfo/list.cgi?schemaversion=2

8. Parse the XML response.

Successful response example
<?xml version="1.0" encoding="UTF-8"?>
<DeviceResponse SchemaVersion="2.1" xmlns:xsi="http://www.w3.org/2001/XMLSchema-instance" xsi:noNamespaceSchemaLocation="http://www.axis.com/vapix/http_cgi/ExternalIpDeviceInfo2.xsd">
<ListDevicesSuccess>
  <Device>
    <Id>example-id_123</Id>
    <Serialnumber>AABBCCDDEEFF1234</Serialnumber>
    <Description>Example extipdev</Description>
    <Address>192.168.0.123</Address>
    <Username>device1</Username>
    <Protocol>rtspsh</Protocol>
    <Port>0</Port>
    <CertificateValidation>standard</CertificateValidation>
  </Device>
  <Device>
    <Id>example-id_124</Id>
    <Serialnumber>AABBCCDDEEFF5678</Serialnumber>
    <Description>Second example extipdev</Description>
    <Address>fe80::aecc:8eff:fee3:64fd</Address>
    <Username>device2</Username>
    <Protocol>rtspsh</Protocol>
    <Port>443</Port>
    <CertificateValidation>standard</CertificateValidation>
  </Device>
  <Device>
    [...]
  <Device/>
</ListDevicesSuccess>
</DeviceResponse>
Error response example
<?xml version="1.0" encoding="UTF-8"?>
<DeviceResponse SchemaVersion="2.1" xmlns:xsi="http://www.w3.org/2001/XMLSchema-instance" xsi:noNamespaceSchemaLocation="http://www.axis.com/vapix/http_cgi/ExternalIpDeviceInfo2.xsd">
  <GeneralError>
    <ErrorCode>10</ErrorCode>
    <Description>An error occurred at system level</Description>
  </GeneralError>
</DeviceResponse>

API specifications

setcacertificates.cgi

list.cgi

update.cgi

API specifications

create.cgi

This method is used when you want to create an external IP device.

Request

Security level

Admin

Method

GET, POST

http://<servername>/axis-cgi/externalipdeviceinfo/create.cgi?<argument>=<data>[&<argument>=<data>[&...]]
ParameterDescription
id=<EXTIPDEVID>The unique external IP device identifier.
description=<DESCRIPTION>The external IP device description (optional).
serialnumber=<SERIALNUMBER>The external IP device serial number. Can be either MAC-addresses or alpha numeric strings (optional).
address=<ADDRESS>The external IP device address or hostname (optional). Both username and password are required when an address is set.
username=<USERNAME>The IP device account name. This parameter is mandatory when address is set.
password=<PASSWORD>The password connected to a username. This parameters is mandatory when address is set.
protocol=<PROTOCOL>The protocol used to retrieve an event stream (optional). In cases where default port mode is used (port given as 0) specifying the protocol will also indirectly set the actual port number. Default port numbers are listed under the port description below. Supported protocols are:

  • rtspt: RTP over RTSP (default)

  • rtsph: RTP over RTSP over HTTP

  • rtspsh: RTP over RTSP over HTTPS (supports certificate validation)

certvalidation="standard"|"limited"|"off"Optional parameter. The following protocols are supported:

  • standard: Enables certificate validation. Please make sure that the protocol supports validation, as the connection will not be permitted otherwise. The signature in the remote device response will be validated along with the installed CA certificates. A connection will not be established unless the response signature matches one of the installed certificates.

  • limited: Enables certificate validation when Common Name is disabled. You need to make sure that the protocol supports validation, otherwise the connection will not be permitted. The signature in the remote device response will be validated along with the installed certificates. A connection will not be established unless the response signature matches one of the installed certificates.

  • off: Disables certificate validation. This is the default value.

port=<PORT>The port used to fetch the event stream (optional). Default value is 0, which means that the stream is using the standard port of the specified protocol.
Port defaults

  • rtspt: 554

  • rtsph: 80

  • rtspsh: 443

Note
Please note that setting the username and password presumes that an account with those credentials has already been created for the external IP device.
Note
External IP devices can be created using just the ID parameter.

Return value - Success

HTTP code

200 OK

Content-Type

text/xml

Response body syntax
<?xml version="1.0" encoding="UTF-8"?>
<DeviceResponse SchemaVersion="2.1" xmlns:xsi="http://www.w3.org/2001/XMLSchema-instance" xsi:noNamespaceSchemaLocation="http://www.axis.com/vapix/http_cgi/ExternalIpDeviceInfo2.xsd">
  <GeneralSuccess/>
</DeviceResponse>

Return value - Error

HTTP code

200 OK

Content-Type

text/xml

Response body syntax
<DeviceResponse SchemaVersion="2.1" xmlns:xsi="http://www.w3.org/2001/XMLSchema-instance" xsi:noNamespaceSchemaLocation="http://www.axis.com/vapix/http_cgi/ExternalIpDeviceInfo2.xsd">
  <GeneralError>
    <ErrorCode>[code]</ErrorCode>
    <Description>[description]</Description>
  </GeneralError>
</DeviceResponse>

Error codes

Error codeDescription
10An error occurred at system level.
30Maximum amount of devices reached.
40Invalid or no id.
60Unsupported schema version.
70Invalid request.
80Processing error.
150Device already exists.
170Invalid description.
180Invalid serialnumber.
190Invalid protocol.
200Invalid port.
210Invalid certificate validation.

See General error codes for a complete list of potential errors.

update.cgi

This method is used when you want to change parameter values on existing IP devices. Please note that the changes won’t take effect until the recording is manually restarted.

Request

Security level

Admin

Method

GET, POST

http://<servername>/axis-cgi/externalipdeviceinfo/update.cgi?<argument>=<data>[&<argument>=<data>[&...]]
ParameterDescription
id=<EXTIPDEVID>The unique external IP device identifier.
description=<DESCRIPTION>The external IP device description (optional).
serialnumber=<SERIALNUMBER>The external IP device serial number. Can be either MAC-addresses or alpha numeric strings (optional).
address=<ADDRESS>The external IP device address or hostname (optional). Both username and password are required when an address is set.
username=<USERNAME>The IP device account name. This parameter is mandatory when address is set.
password=<PASSWORD>The password connected to a username. This parameters is mandatory when address is set.
protocol=<PROTOCOL>The protocol used to retrieve an event stream (optional). The protocol used to retrieve an event stream (optional). In cases where default port mode is used (port given as 0) specifying the protocol will also indirectly set the actual port number. Default port numbers are listed under the port description below. Supported protocols are:

  • rtspt: RTP over RTSP (default)

  • rtsph: RTP over RTSP over HTTP

  • rtspsh: RTP over RTSP over HTTPS (supports certificate validation)

certvalidation="standard"|"limited"|"off"Optional parameter. The following protocols are supported:

  • standard: Enables certificate validation. Please make sure that the protocol supports validation, as the connection will not be permitted otherwise. The signature in the remote device response will be validated along with the installed CA certificates. A connection will not be established unless the response signature matches one of the installed certificates.

  • limited: Enables certificate validation when Common Name is disabled. You need to make sure that the protocol supports validation, otherwise the connection will not be permitted. The signature in the remote device response will be validated along with the installed certificates. A connection will not be established unless the response signature matches one of the installed certificates.

  • off: Disables certificate validation. This is the default value.

port=<PORT>The port used to fetch the event stream (optional). Default value is 0, which means that the stream is using the standard port of the specified protocol.
Port defaults

  • rtspt: 554

  • rtsph: 80

  • rtspsh: 443

Return value - Success

HTTP code

200 OK

Content-Type

text/xml

Response body syntax
<?xml version="1.0" encoding="UTF-8"?>
<DeviceResponse SchemaVersion="2.1" xmlns:xsi="http://www.w3.org/2001/XMLSchema-instance" xsi:noNamespaceSchemaLocation="http://www.axis.com/vapix/http_cgi/ExternalIpDeviceInfo2.xsd">
  <GeneralSuccess/>
</DeviceResponse>

Return value - Error

HTTP code

200 OK

Content-Type

text/xml

Response body syntax
<DeviceResponse SchemaVersion="2.1" xmlns:xsi="http://www.w3.org/2001/XMLSchema-instance" xsi:noNamespaceSchemaLocation="http://www.axis.com/vapix/http_cgi/ExternalIpDeviceInfo2.xsd">
  <GeneralError>
    <ErrorCode>[code]</ErrorCode>
    <Description>[description]</Description>
  </GeneralError>
</DeviceResponse>

Error codes

Error codeDescription
10An error occurred at system level.
40Invalid or no id.
60Unsupported schema version.
80Processing error.
90No device.
170Invalid description.
180Invalid serialnumber.
190Invalid protocol.
200Invalid port.
210Invalid certificate validation.

See General error codes for a complete list of potential errors.

delete.cgi

This method is used when you want to delete an external IP device.

Request

Security level

Admin

Method

GET, POST

http://<servername>/axis-cgi/externalipdeviceinfo/delete.cgi?<argument>=<data>[&<argument>=<data>[&...]]
ParameterDescription
id=<EXTIPDEVID>The unique external IP device identifier.
Note
Use update.cgi to delete individual parameters from an existing device.

Return value - Success

HTTP code

200 OK

Content-Type

text/xml

Response body syntax
<?xml version="1.0" encoding="UTF-8"?>
<DeviceResponse SchemaVersion="2.1" xmlns:xsi="http://www.w3.org/2001/XMLSchema-instance" xsi:noNamespaceSchemaLocation="http://www.axis.com/vapix/http_cgi/ExternalIpDeviceInfo2.xsd">
  <GeneralSuccess/>
</DeviceResponse>

Return value - Error

HTTP code

200 OK

Content-Type

text/xml

Response body syntax
<DeviceResponse SchemaVersion="2.1" xmlns:xsi="http://www.w3.org/2001/XMLSchema-instance" xsi:noNamespaceSchemaLocation="http://www.axis.com/vapix/http_cgi/ExternalIpDeviceInfo2.xsd">
  <GeneralError>
    <ErrorCode>[code]</ErrorCode>
    <Description>[description]</Description>
  </GeneralError>
</DeviceResponse>

Error codes

Error codeDescription
10An error occurred at system level.
40Invalid or no id.
60Unsupported schema version.
80Processing error.
90No device.

See General error codes for a complete list of potential errors.

list.cgi

This method is used when you want to list all available external IP devices.

Request

Security level

Admin

Method

GET, POST

http://<servername>/axis-cgi/externalipdeviceinfo/list.cgi?<argument>=<data>[&<argument>=<data>[&...]]

Return value - Success

HTTP code

200 OK

Content-Type

text/xml

Successful response example
<?xml version="1.0" encoding="UTF-8"?>
<DeviceResponse SchemaVersion="2.1" xmlns:xsi="http://www.w3.org/2001/XMLSchema-instance" xsi:noNamespaceSchemaLocation="http://www.axis.com/vapix/http_cgi/ExternalIpDeviceInfo2.xsd">
<ListDevicesSuccess>
  <Device>
    <Id>example-id_123</Id>
    <Serialnumber>AABBCCDDEEFF1234</Serialnumber>
    <Description>Example extipdev</Description>
    <Address>192.168.0.123</Address>
    <Username>device1</Username>
    <Protocol>rtspt</Protocol>
    <Port>0</Port>
    <CertificateValidation>off</CertificateValidation>
  </Device>
  <Device>
    <Id>example-id_124</Id>
    <Serialnumber>AABBCCDDEEFF5678</Serialnumber>
    <Description>Second example extipdev</Description>
    <Address>fe80::aecc:8eff:fee3:64fd</Address>
    <Username>device2</Username>
    <Protocol>rtspt</Protocol>
    <Port>0</Port>
    <CertificateValidation>off</CertificateValidation>
  </Device>
  <Device>
    ...
  <Device/>
</ListDevicesSuccess>
</DeviceResponse>

Return value - Error

HTTP code

200 OK

Content-Type

text/xml

Response body syntax
<DeviceResponse SchemaVersion="2.1" xmlns:xsi="http://www.w3.org/2001/XMLSchema-instance" xsi:noNamespaceSchemaLocation="http://www.axis.com/vapix/http_cgi/ExternalIpDeviceInfo2.xsd">
  <GeneralError>
    <ErrorCode>[code]</ErrorCode>
    <Description>[description]</Description>
  </GeneralError>
</DeviceResponse>

Error codes

Error codeDescription
10An error occurred at system level.
60Unsupported schema version.
80Processing error.

See General error codes for a complete list of potential errors.

seteventsenabled.cgi

This method is used when you want to enable or disable events from an external IP device. Supported events are VMD2, VMD3, VMD4 and VMDLite.

Request

Security level

Admin

Method

GET, POST

http://<servername>/axis-cgi/externalipdeviceinfo/seteventsenabled.cgi?<argument>=<data>[&<argument>=<data>[&...]]
ParameterDescription
id=<EXTIPDEVID>The unique external IP device identifier.
enabled="YES"|"yes"|"enabled"|"NO"|"no"|"disabled""YES"|"yes"|"enabled": Enables events found on the external IP device.
"NO"|"no"|"disabled": Disables events found on the external IP device.
Note
Please note that events may not be supported depending on firmware version or device type.

Return value - Success

HTTP code

200 OK

Content-Type

text/xml

Response body syntax
<?xml version="1.0" encoding="UTF-8"?>
<DeviceResponse SchemaVersion="2.1" xmlns:xsi="http://www.w3.org/2001/XMLSchema-instance" xsi:noNamespaceSchemaLocation="http://www.axis.com/vapix/http_cgi/ExternalIpDeviceInfo2.xsd">
  <GeneralSuccess/>
</DeviceResponse>

Return value - Error

HTTP code

200 OK

Content-Type

text/xml

Response body syntax
<DeviceResponse SchemaVersion="2.1" xmlns:xsi="http://www.w3.org/2001/XMLSchema-instance" xsi:noNamespaceSchemaLocation="http://www.axis.com/vapix/http_cgi/ExternalIpDeviceInfo2.xsd">
  <GeneralError>
    <ErrorCode>[code]</ErrorCode>
    <Description>[description]</Description>
  </GeneralError>
</DeviceResponse>

Error codes

Error codeDescription
10An error occurred at system level.
40Invalid or no id.
60Unsupported schema version.
70Invalid request.
80Processing error.
90No device.

See General error codes for a complete list of potential errors.

geteventsenabled.cgi

This method is used when you want to retrieve an enabled event state from an external IP device.

Request

Security level

Admin

Method

GET, POST

http://<servername>/axis-cgi/externalipdeviceinfo/geteventsenabled.cgi?<argument>=<data>[&<argument>=<data>[&...]]
ParameterDescription
id=<EXTIPDEVID>The unique external IP device identifier.

Return value - Success

HTTP code

200 OK

Content-Type

text/xml

Response body syntax
<DeviceResponse SchemaVersion="2.1" xmlns:xsi="http://www.w3.org/2001/XMLSchema-instance" xsi:noNamespaceSchemaLocation="http://www.axis.com/vapix/http_cgi/ExternalIpDeviceInfo2.xsd">
  <GetEventsEnabledSuccess>
    <Id>[id]</Id>
    <EventsEnabled>[YES/NO]</EventsEnabled>
  </GetEventsEnabledSuccess>
</DeviceResponse>

Return value - Error

HTTP code

200 OK

Content-Type

text/xml

Response body syntax
<DeviceResponse SchemaVersion="2.1" xmlns:xsi="http://www.w3.org/2001/XMLSchema-instance" xsi:noNamespaceSchemaLocation="http://www.axis.com/vapix/http_cgi/ExternalIpDeviceInfo2.xsd">
  <GeneralError>
    <ErrorCode>[code]</ErrorCode>
    <Description>[description]</Description>
  </GeneralError>
</DeviceResponse>

Error codes

Error codeDescription
10An error occurred at system level.
40Invalid or no id.
60Unsupported schema version.
80Processing error.
90No device.

See General error codes for a complete list of potential errors.

setcacertificates.cgi

This method is used when you want to set up a list of installed CA certificates to validate streams from external IP devices that has certificate validation enabled. Using the certvalidation parameter found in create.cgi and update.cgi will specify if the certificate validation should be used for a particular external IP device (default value is off). The list of CA certificate IDs passed to this function will replace the current list of IDs, while calling this function with no input, i.e. an empty list, will unset all currently configured CA certificate IDs.

  • The CA certificate must be installed prior to calling this method. See Certificate management API for additional information on how to upload CA certificates.

  • A CA certificate must be unset with this method before it can be uninstalled.

  • getcacertificates.cgi can be used to list already configured CA certificate IDs that would be overridden by this method.

  • External IP devices with both events and certificate validation enabled when calling this method will have their event streams reset to ensure that the event stream use the correct CA. Using an installed CA certificate while the same CA certificate ID is missing from the certids parameter will cause a disruption in the event stream.

  • Changes made to ongoing recordings will take effect the next time the recording is manually restarted. This API is able to restart the event streams for External IP devices, but not recordings. Any ongoing recording will continue, but they will not use the new list of CA certificates before being restarted.

  • It is possible to set multiple CA certificates in the same API call.

Request

Security level

Admin

Method

GET, POST

http://<servername>/axis-cgi/externalipdeviceinfo/setcacertificates.cgi?<argument>=<data>[&<argument>=<data>[&...]]
ParameterDescription
schemaversion=<integer>The major XML schema version that should be used.
certids=<CERTID>[,<CERTID>[,...]]Defines the CA id (optional). All current CAs will be turned off if this parameter is left undefined.
Multiple CA ids can be set at once as a comma separated list. Please note that using this method will replace any pre-existing list of CA certificates.

Return value - Success

HTTP code

200 OK

Content-Type

text/xml

Response body syntax
<?xml version="1.0" encoding="UTF-8"?>
<DeviceResponse SchemaVersion="2.1" xmlns:xsi="http://www.w3.org/2001/XMLSchema-instance" xsi:noNamespaceSchemaLocation="http://www.axis.com/vapix/http_cgi/ExternalIpDeviceInfo2.xsd">
  <GeneralSuccess/>
</DeviceResponse>

Return value - Error

HTTP code

200 OK

Content-Type

text/xml

Response body syntax
<DeviceResponse SchemaVersion="2.1" xmlns:xsi="http://www.w3.org/2001/XMLSchema-instance" xsi:noNamespaceSchemaLocation="http://www.axis.com/vapix/http_cgi/ExternalIpDeviceInfo2.xsd">
  <GeneralError>
    <ErrorCode>[code]</ErrorCode>
    <Description>[description]</Description>
  </GeneralError>
</DeviceResponse>

Error codes

Error codeDescription
10An error occurred at system level.
60Unsupported schema version.
80Processing error.
220Invalid CA certificate.

See General error codes for a complete list of potential errors.

getcacertificates.cgi

This method is used when you want to retrieve a list of one or multiple configured CA certificates using a single API call.

Request

Security level

Admin

Method

GET, POST

http://<servername>/axis-cgi/externalipdeviceinfo/getcacertificates.cgi?<argument>=<data>[&<argument>=<data>[&...]]
ParameterDescription
schemaversion=<integer>The major XML schema version that should be used.

Return value - Success

HTTP code

200 OK

Content-Type

text/xml

Response body syntax
<?xml version="1.0" encoding="UTF-8"?>
<DeviceResponse SchemaVersion="2.1" xmlns:xsi="http://www.w3.org/2001/XMLSchema-instance" xsi:noNamespaceSchemaLocation="http://www.axis.com/vapix/http_cgi/ExternalIpDeviceInfo2.xsd">
<GetCACertificatesSuccess>
  <CACertificate>
    <Id>Ca-id_1</Id>
  </CACertificate>
  <CACertificate>
    <Id>Ca-id_2</Id>
  </CACertificate>
  <CACertificate>
    [...]
  <CACertificate/>
</GetCACertificatesSuccess>
</DeviceResponse>

Return value - Error

HTTP code

200 OK

Content-Type

text/xml

Response body syntax
<DeviceResponse SchemaVersion="2.1" xmlns:xsi="http://www.w3.org/2001/XMLSchema-instance" xsi:noNamespaceSchemaLocation="http://www.axis.com/vapix/http_cgi/ExternalIpDeviceInfo2.xsd">
  <GeneralError>
    <ErrorCode>[code]</ErrorCode>
    <Description>[description]</Description>
  </GeneralError>
</DeviceResponse>

Error codes

Error codeDescription
10An error occurred at system level.
60Unsupported schema version.
80Processing error.

See General error codes for a complete list of potential errors.

schemaversions.cgi

This method is used when you want to retrieve a list of supported XML schema versions.

Request

Security level

Admin

Method

GET, POST

http://<servername>/axis-cgi/externalipdeviceinfo/schemaversions.cgi

Return value - Success

HTTP code

200 OK

Content-Type

text/xml

Response body syntax
<?xml version="1.0" encoding="utf-8"?>
<DeviceResponse SchemaVersion="2.1" xmlns:xsi="http://www.w3.org/2001/XMLSchema-instance" xsi:noNamespaceSchemaLocation="http://www.axis.com/vapix/http_cgi/ExternalIpDeviceInfo2.xsd">
  <SchemaVersionsSuccess>
    <SchemaVersion>
      <VersionNumber>[major].[minor]</VersionNumber>
    </SchemaVersion>
  </SchemaVersionsSuccess>
</DeviceResponse>

Return value - Error

HTTP code

200 OK

Content-Type

text/xml

Response body syntax
<DeviceResponse SchemaVersion="2.1" xmlns:xsi="http://www.w3.org/2001/XMLSchema-instance" xsi:noNamespaceSchemaLocation="http://www.axis.com/vapix/http_cgi/ExternalIpDeviceInfo2.xsd">
  <GeneralError>
    <ErrorCode>[code]</ErrorCode>
    <Description>[description]</Description>
  </GeneralError>
</DeviceResponse>

See General error codes for a complete list of potential errors.

General error codes

The following table contains all errors that can occur for any CGI method. For method specific errors, see the API description for that particular method.

Error codeDescription
10An error occurred at system level.
30Maximum amount of devices reached.
40Invalid or no id.
60Unsupported schema version.
70Invalid request.
80Processing error.
90No device.
150Device already exists.
170Invalid description.
180Invalid serialnumber.
190Invalid protocol.
200Invalid port.
210Invalid certificate validation.
220Invalid CA certificate.
Event streaming over WebSocket
Feature Flag Service
Cookie settings
 • 
My Axis
 • 
Developer community
 • 
About

©2008 - 2024 Axis Communications AB. AXIS COMMUNICATIONS, AXIS, ARTPEC and VAPIX are registered trademarks of Axis AB in various jurisdictions. All other trademarks are the property of their respective owners. We reserve the right to introduce modifications without notice.