Edge storage API

These examples demonstrate how to set up an Axis product to record continuously to a network share.

http://myserver/axis-cgi/disks/networkshare/add.cgi?schemaversion=1
&nicename=My%20Share&address=mynas&share=myshare&user=nasuser&pass=pass

http://myserver/axis-cgi/disks/networkshare/bind.cgi?schemaversion=1
&shareid=35419

http://myserver/axis-cgi/disks/list.cgi?diskid=NetworkShare

HTTP/1.0 200 OK
Content-Type: text/xml
 
<?xml version="1.0" ?>
<root xmlns:xsi="http://www.w3.org/2001/XMLSchema-instance" 
    xsi:noNamespaceSchemaLocation=
    "http://www.axis.com/vapix/http_cgi/disk/list1.xsd">
  <disks numberofdisks="1">
    <disk diskid="NetworkShare"
      name="My Share" 
      totalsize="4194304000"
      freesize="3355443200"
      cleanuplevel="95"
      cleanupmaxage="1"
      cleanuppolicy="none"
      locked="no"
      full="no"
      readonly="no"
      filesystem="cifs"
      status="OK"
      group="S1"
      requiredfilesystem="none"/>
  </disks>
</root>

http://myserver/axis-cgi/param.cgi?action=update
&Storage.S1.CleanupPolicyActive=fifo
&Storage.S1.CleanupMaxAge=7

http://myserver/axis-cgi/record/continuous/addconfiguration.cgi?diskid=NetworkShare
&eventid=continuous_nas&options=resolution%3D640x480

http://myserver/axis-cgi/record/list.cgi?listentity=recordingid
&eventid=continuous_nas
&starttime=2011-08-12T08:12:11Z
&stoptime=2011-08-14T10:10:00Z

HTTP/1.0 200 OK
Content-Type: text/xml
   
<?xml version="1.0" ?>
<root xmlns:xsi="http://www.w3.org/2001/XMLSchema-instance" 
    xsi:noNamespaceSchemaLocation=
    "http://www.axis.com/vapix/http_cgi/recording/list1.xsd">
  <recordings totalnumberofrecordings="6" numberofrecordings="3" >
    <recording diskid="NetworkShare"
      recordingid="20110812_081211_016F_00408C1834FD"
      starttime="2011-08-12T08:12:11Z" 
      stoptime="2011-08-13T09:30:30Z" ... > 
      <video ... />  
      <audio ... /> 
    </recording> 
    <recording diskid="NetworkShare"
      recordingid="20110813_093530_025B_00408C1834FD" 
      starttime="2011-08-13T09:35:30Z" 
      stoptime="2011-08-13T010:30:30Z" ... > 
      <video ... />  
      <audio ... /> 
    </recording> 
    <recording diskid="NetworkShare"
      recordingid="20110813_103530_037C_00408C1834FD" 
      starttime="2011-08-13T010:35:30Z" 
      stoptime="2011-08-14T10:10:00Z" ... > 
      <video ... /> 
      <audio ... /> 
    </recording> 
  </recordings> 
</root>

PLAY rtsp://myserver/axis-media/media.amp?recordingid=Rec.recordingid
Range: clock=Rec.starttime-Rec.stoptime

These examples demonstrate how to use an SD card with an Axis product.

http://myserver/axis-cgi/param.cgi?action=update
&Storage.S0.FriendlyName=My&20SD%20Card

http://myserver/axis-cgi/disks/getcapabilities.cgi?diskid=SD_DISK

HTTP/1.0 200 OK
Content-Type: text/xml
 
<?xml version="1.0" encoding="UTF-8"?>
<root xmlns:xsi="http://www.w3.org/2001/XMLSchema-instance" 
    xsi:noNamespaceSchemaLocation=
    "http://www.axis.com/vapix/http_cgi/disk/capabilities1.xsd”>
  <disk diskid="SD_DISK" requiredfssupported="true">
    <filesystems>
      <filesystem name="vfat" nicename=" " requiredfssupported="false"/>
      <filesystem name="ext4" nicename=" " requiredfssupported="true"/>
    </filesystems>
  </disk>
</root>

http://myserver/axis-cgi/disks/format.cgi?diskid=SD_DISK&filesystem=ext4

http://myserver/axis-cgi/disks/job.cgi?jobid=4&diskid=SD_DISK

HTTP/1.0 200 OK
Content-Type: text/xml
 
<?xml version="1.0" ?>
<root xmlns:xsi="http://www.w3.org/2001/XMLSchema-instance" 
    xsi:noNamespaceSchemaLocation=
    "http://www.axis.com/vapix/http_cgi/disk/checkjob1.xsd">
  <job jobid="4"
    diskid="SD_DISK"
    action="format"
    result="OK"
    progress="15"
</root>

15% 
32%
45%
68%
92%
Done!

http://myserver/axis-cgi/record/continuous/addconfiguration.cgi?diskid=SD_DISK
&options=resolution%3D640x480&eventid=continuous_0

Disks are removable storage devices such as SD cards and network shares. The Disk management API is used to manage disks, for example to list, format, mount and lock disks.

If using a network share, the share must first be added and bound to the disk using the Network Share API, see Network share API.

A disk is identified by its Disk ID. The Disk ID identifies a disk drive and not the physical disk, that is, the Disk ID does not change if the SD card or network share is replaced. For example, consider a network share with Disk ID NetworkShare. If the network share is unbound and replaced with a new one, the new share is also associated with the Disk ID NetworkShare.

The Disk management API consists of the following CGIs:

The responses from format.cgi, checkdisk.cgi, repair.cgi and mount.cgi show if the job has been started or not. A successfully started job returns a Job ID, which should be used as input to job.cgi. Typically, job.cgi is run repeatedly until the job is finished. This workflow allows a user interface to be more responsive and to report the progress of a job by displaying incremental status updates, for example in a progress bar.

Identification

Obsoletes

Storage properties parameters

The parameters in the Properties.LocalStorage group identify the storage capabilities supported by the Axis product.

Mount directory parameters

Storage parameters

The parameters in the Storage group are used for disk management.

The # is replaced by a group number, for example Storage.S0. The group number is an integer between 0 and N, where N is the number of disks supported by the Axis product.

Use disks/list.cgi to retrieve information about available disks and their status. An available disk is mounted and ready to be used.

Request

Access control

admin, operator

Method

GET

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

With the following arguments and values:

Response

Responses from disks/list.cgi

Success:

HTTP code

200 OK

Content-type

text/xml

<?xml version="1.0" ?>
<root xmlns:xsi="http://www.w3.org/2001/XMLSchema-instance" 
    xsi:noNamespaceSchemaLocation=
    "http://www.axis.com/vapix/http_cgi/disk/list1.xsd">
  <disks numberofdisks="[number of disks returned in xml]">
    <disk diskid="[storage parameter DiskID]"
      name="[storage parameter FriendlyName]" 
      totalsize="[total size of storage in kB]"
      freesize="[free space of storage in kB]"
      cleanuplevel="[storage parameter CleanupLevel]"
      cleanupmaxage="[storage parameter CleanupMaxAge]"
      cleanuppolicy="[storage parameter CleanupPolicyActive]"
      locked="[storage parameter Locked]"
      full="[storage full]"
      readonly="[storage read only]"
      filesystem="[file system of storage]"
      status="[disk status]"
      group="[storage group]"
      requiredfilesystem="[required file system]"
      diskencryptionenabled="[true|false]"
      diskencrypted="[true|false]"/>
  </disks>
</root>

In the disks/list.cgi response, some elements contain yes/no and some contain true/false.

Supported elements, attributes and values:

Use disks/format.cgi format disks. Disks are normally preformatted but can be reformatted with a different file system.

Any data present on the disk is lost when the disk is formatted.

The response shows if the job has been started or not. A successfully started job returns a Job ID, which should be used as input to job.cgi, see Job progress.

SD cards can be formatted with ext4 or vfat. Using ext4 is recommended to reduce the risk of data loss if the card is ejected and after abrupt power cycling. To read SD cards formatted with ext4 on Windows, additional software is needed.

To format a network share, set the argument filesystem to cifs. Formatting a network share removes all data recorded to the share by the Axis product performing the operation. Data uploaded to a network share recipient and recordings made by other Axis products are not removed.

Use getcapabilities.cgi to retrieve the file systems that the disk can be formatted with.

If required file system has been set, the disk is formatted automatically when mounted. See Set required file system.

If disk encryption is enabled, the disk is encrypted when formatted. See Enable disk encryption.

Request

Access control

admin

Method

GET

http://<servername>/axis-cgi/disks/format.cgi?<argument>=<value>
[&<argument>=<value>...]

With the following arguments and values:

Response

Responses from disks/format.cgi

Success:

HTTP code

200 OK

Content-type

text/xml

<?xml version="1.0" ?>
<root xmlns:xsi="http://www.w3.org/2001/XMLSchema-instance" 
    xsi:noNamespaceSchemaLocation=
    "http://www.axis.com/vapix/http_cgi/disk/startjob1.xsd">
  <job action="format"
    diskid="[Disk ID]"
    result="OK"
    jobid="[ID of the started job]"/>
</root>

Error:

HTTP code

200 OK

Content-type

text/xml

<?xml version="1.0" ?>
<root xmlns:xsi="http://www.w3.org/2001/XMLSchema-instance" 
    xsi:noNamespaceSchemaLocation=
    "http://www.axis.com/vapix/http_cgi/disk/startjob1.xsd">
  <job action="format"
    diskid="[Disk ID]"
    result="ERROR"
    description="[error description]"/>
</root>

Supported elements, attributes and values:

Use disks/checkdisk.cgi to check the integrity of the file system. If an error is found, try using repair.cgi to repair the file system.

The response shows if the job has been started or not. A successfully started job returns a Job ID, which should be used as input to job.cgi, see Job progress.

Only SD cards formatted with ext4 can be checked using this CGI.

The request fails if the disk is mounted or if disk encryption is enabled without a valid passphrase.

Request

Access control

admin, operator

Method

GET

http://<servername>/axis-cgi/disks/checkdisk.cgi?<argument>=<value>
[&<argument>=<value>...]

With the following arguments and values:

Response

Responses from disks/checkdisk.cgi

Success:

HTTP code

200 OK

Content-type

text/xml

<?xml version="1.0" ?>
<root xmlns:xsi="http://www.w3.org/2001/XMLSchema-instance" 
    xsi:noNamespaceSchemaLocation=
    "http://www.axis.com/vapix/http_cgi/disk/startjob1.xsd">
  <job action="checkdisk"
    diskid="[Disk ID]"
    result="OK"
    jobid="[ID of the started job]"/>
</root>

Error:

HTTP code

200 OK

Content-type

text/xml

<?xml version="1.0" ?>
<root xmlns:xsi="http://www.w3.org/2001/XMLSchema-instance" 
    xsi:noNamespaceSchemaLocation=
    "http://www.axis.com/vapix/http_cgi/disk/startjob1.xsd">
  <job action="checkdisk"
    diskid="[Disk ID]"
    result="ERROR"
    description="[error description]"/>
</root>

Supported elements, attributes and values:

Use disks/repair.cgi to perform a file system repair on the selected disk.

Repairing a disk may result in lost data.

The response shows if the job has been started or not. A successfully started job returns a Job ID, which should be used as input to job.cgi, see Job progress.

Only SD cards formatted with ext4 can be repaired using this CGI.

The request fails if the disk is mounted or if disk encryption is enabled without a valid passphrase.

Request

Access control

admin

Method

GET

http://<servername>/axis-cgi/disks/repair.cgi?<argument>=<value>
[&<argument>=<value>...]

With the following arguments and values:

Response

Responses from disks/repair.cgi

Success:

HTTP code

200 OK

Content-type

text/xml

<?xml version="1.0" ?>
<root xmlns:xsi="http://www.w3.org/2001/XMLSchema-instance" 
    xsi:noNamespaceSchemaLocation=
    "http://www.axis.com/vapix/http_cgi/disk/startjob1.xsd">
  <job action="repair"
    diskid="[Disk ID]"
    result="OK"
    jobid="[ID of the started job]"/>
</root>

Error:

HTTP code

200 OK

Content-type

text/xml

<?xml version="1.0" ?>
<root xmlns:xsi="http://www.w3.org/2001/XMLSchema-instance" 
    xsi:noNamespaceSchemaLocation=
    "http://www.axis.com/vapix/http_cgi/disk/startjob1.xsd">
  <job action="repair"
    diskid="[Disk ID]"
    result="ERROR"
    description="[error description]"/>
</root>

Supported elements, attributes and values:

Use disks/mount.cgi to mount a disk to the system and to unmount a disk from the system.

To prevent corruption of recordings, SD cards should always be unmounted before being ejected.

The response shows if the job has been started or not. A successfully started job returns a Job ID, which should be used as input to job.cgi, see Job progress.

Mounting is done automatically:

• when an SD card is inserted

• when a network share is bound to a disk

• when the system boots (provided that an SD is inserted or a network share has been bound)

A manual mount is only required if a disk has been unmounted and not automatically remounted (for example by a system restart).

Unmounting makes the disk unavailable to the system. A disk that has been unmounted can be safely removed from the product.

Request

Access control

admin

Method

GET

http://<servername>/axis-cgi/disks/mount.cgi?<argument>=<value>
[&<argument>=<value>...]

With the following arguments and values:

Response

Responses from disks/mount.cgi

Success:

HTTP code

200 OK

Content-type

text/xml

<?xml version="1.0" ?>
<root xmlns:xsi="http://www.w3.org/2001/XMLSchema-instance" 
    xsi:noNamespaceSchemaLocation=
    "http://www.axis.com/vapix/http_cgi/disk/startjob1.xsd">
  <job action="[requested action]"
    diskid="[Disk ID]"
    result="OK"
    jobid="[ID of the started job]"/>
</root>

Error:

HTTP code

200 OK

Content-type

text/xml

<?xml version="1.0" ?>
<root xmlns:xsi="http://www.w3.org/2001/XMLSchema-instance" 
    xsi:noNamespaceSchemaLocation=
    "http://www.axis.com/vapix/http_cgi/disk/startjob1.xsd">
  <job action="[requested action]"
    diskid="[Disk ID]"
    result="ERROR"
    description="[error description]"/>
</root>

Supported elements, attributes and values:

Use disks/job.cgi to check the progress of a format, check disk, repair, mount or unmount job.

The job should be started by running one of format.cgi, checkdisk.cgi, repair.cgi and mount.cgi. If the job could be started successfully, a Job ID is returned. This Job ID is used as input to job.cgi. Typically, job.cgi is run repeatedly until the job is finished. This workflow allows a user interface to be more responsive and to report the progress of a job by displaying incremental status updates, for example in a progress bar.

Request

Access control

admin, operator

Method

GET

http://<servername>/axis-cgi/disks/job.cgi?<argument>=<value>[&<argument>=<value>...]

With the following arguments and values:

Response

Responses from disks/job.cgi

Success:

HTTP code

200 OK

Content-type

text/xml

<?xml version="1.0" ?>
<root xmlns:xsi="http://www.w3.org/2001/XMLSchema-instance" 
    xsi:noNamespaceSchemaLocation=
    "http://www.axis.com/vapix/http_cgi/disk/checkjob1.xsd">
  <job jobid="[ID of the started job]"
    diskid="[Disk ID]"
    action="[requested action]"
    result="OK"
    progress="[percentage done]"
    description="[result description]"/>
</root>

Error:

HTTP code

200 OK

Content-type

text/xml

<?xml version="1.0" ?>
<root xmlns:xsi="http://www.w3.org/2001/XMLSchema-instance" 
    xsi:noNamespaceSchemaLocation=
    "http://www.axis.com/vapix/http_cgi/disk/checkjob1.xsd">
  <job jobid="[ID of the started job]"
    diskid="[Disk ID]"
    action="[current action]"
    progress="100"
    result="ERROR"
    description="[error description]"/>
</root>

Supported attributes and values:

Use disks/lock.cgi to lock or unlock a disk. When locked, all active recording are stopped and saved recordings cannot be removed. A locked disk cannot be formatted or written to.

Request

Access control

admin

Method

GET

http://<servername>/axis-cgi/disks/lock.cgi?<argument>=<value>
[&<argument>=<value>...]

With the following arguments and values:

Response

Responses from disks/lock.cgi

Return:

HTTP code

200 OK

Content-type

text/xml

<?xml version="1.0" ?>
<root xmlns:xsi="http://www.w3.org/2001/XMLSchema-instance" 
    xsi:noNamespaceSchemaLocation=
    "http://www.axis.com/vapix/http_cgi/disk/lock1.xsd">
  <lock diskid="[Disk ID]"
    result="OK"/>
</root>

or

<?xml version="1.0" ?>
<root xmlns:xsi="http://www.w3.org/2001/XMLSchema-instance" 
    xsi:noNamespaceSchemaLocation=
    "http://www.axis.com/vapix/http_cgi/disk/lock1.xsd">
  <unlock diskid="[Disk ID]"
    result="OK"/>
</root>

Supported attributes and values:

Use disks/getcapabilities.cgi to list the capabilities supported by the disk. The response shows the file systems that the disk can be formatted with, if required file system is supported and if disk encryption is supported.

Request

Access control

admin, operator

Method

GET

http://<servername>/axis-cgi/disks/getcapabilities.cgi?<argument>=<value>
[&<argument>=<value>...]

With the following arguments and values:

Response

Responses from disks/getcapabilities.cgi

HTTP code

200 OK

Content-type

text/xml

<?xml version="1.0" ?>
<root xmlns:xsi="http://www.w3.org/2001/XMLSchema-instance" 
    xsi:noNamespaceSchemaLocation=
    "http://www.axis.com/vapix/http_cgi/disk/capabilities1.xsd">
  <disk diskid="[Disk ID]" requiredfssupported="[true|false]" encryptionsupported="[true|false]">
    <filesystems> 
      <filesystem 
          name="[filesystem 1]" 
          nicename="[filesystem 1]" 
          requiredfssupported="[true|false]"/>
      <filesystem 
          name="[filesystem 2]" 
          nicename="[filesystem 2]" 
          requiredfssupported="[true|false]"/>
      ...
    </filesystems> 
  </disk>
</root>

Supported elements, attributes and values:

Use gethealth.cgi to list the health status (wear level, temperature and overall health) of all disks.

Note: Requires Firmware 7.20 and later.

Request

Access control

admin, operator

Method

GET

http://<servername>/axis-cgi/disks/gethealth.cgi

Response

HTTP code

200 OK

Content-type

text/xml

<?xml version="1.0" encoding="UTF-8"?>
<HealthStatusResponse xmlns:xsi="http://www.w3.org/2001/XMLSchema-instance" xsi:noNamespaceSchemaLocation="http://www.axis.com/vapix/http_cgi/disk/gethealth1.xsd">
  <HealthStatusSuccess>
    <HealthStatus diskid="SD_DISK" wear="25"/>
    <HealthStatus diskid="NetworkShare" wear="-1"/>
    <HealthStatus diskid="HDD_DISK" wear="13" temperature="315" overallhealth="1"/>
  </HealthStatusSuccess>
</HealthStatusResponse>

The wear attribute value shows how much of the disk's expected life span (in percent) that has passed. The value can exceed 100 percent.

The temperature attribute value shows the disk temperature in Kelvin degrees (315 degrees Kelvin = 42 degrees Celsius). Note: Firmware 9.50 and later.

The overallhealth attribute value shows the overall health status for the device (0 = FAIL, 1 = PASSED). Note: Firmware 9.50 and later.

The Health Status attributes can also have one of the following negative values: -1 means that the feature is not supported for the disk, -2 means that an error occured, -3 means that the disk is not present.

<?xml version="1.0" ?>
<HealthStatusResponse xmlns:xsi="http://www.w3.org/2001/XMLSchema-instance" xsi:noNamespaceSchemaLocation="http://www.axis.com/vapix/http_cgi/disk/gethealth1.xsd">
  <GeneralError>
    <ErrorCode[code]/ErrorCode>
    <ErrorDescription[description]/ErrorDescription>
  </GeneralError>
</HealthStatusResponse>

VAPIX® Disk properties API is used to configure various disk properties. The API consists of the following CGIs:

Identification

Use disks/properties/setrequiredfs.cgi to enable and set a required file system for the disk. Required file system is disabled by default.

Required file system is used to automatically format SD cards to the file system set as required file system.

If required file system has been set, the Axis product checks each mounted SD card to see if the card uses the required file system. If the card uses another file system, or if the file system cannot be determined, the card is formatted to the required file system automatically. During formatting, any data on the card is lost.

An SD card that has been locked (using the switch on the card or using disks/lock.cgi) is not reformatted. If the card is unlocked using disks/lock.cgi, the card will be formatted the next time it is mounted.

If a required file system is set while a card is mounted and in use, the card will be reformatted when it is remounted and all data will be lost.

Request

Access control

admin

Method

GET

http://<servername>/axis-cgi/disks/properties/setrequiredfs.cgi?<argument>=<value>
[&<argument>=<value>...]

With the following arguments and values:

Response

Responses from disks/properties/setrequiredfs.cgi

Success

If the request is successful, required file system is set and a Success response is returned. See General success response.

Error

If an error occurred, an Error response is returned. See General error response.

Error codes: 10, 20, 30, 40

Use disks/properties/enablediskencryption.cgi to enable disk encryption.

Disk encryption is disabled by default. Disk encryption can only be enabled when the disk is unmounted. After enabling disk encryption, the disk must be formatted and mounted. See Disk encryption.

Request

Access control

admin

Method

GET

http://<servername>/axis-cgi/disks/properties/enablediskencryption.cgi?<argument>=<value>&[<argument>=<value>...]

with the following arguments and values:

Response

Responses from disks/properties/enablediskencryption.cgi

Success

If the request is successful, the disk content is encrypted and a Success response is returned. See General success response.

Error

If an error occurred, an Error response is returned. See General error response.

Error codes: 10, 20, 40, 50, 100, 110, 140, 160

Use disks/properties/disablediskencryption.cgi to disable disk encryption.

Disk encryption can only be disabled when the disk is unmounted. After disabling disk encryption, the disk must be mounted and formatted.

Request

Access control

admin

Method

GET

http://<servername>/axis-cgi/disks/properties/disablediskencryption.cgi?<argument>=<value>&[<argument>=<value>...]

with the following arguments and values:

Response

Responses from disks/properties/disablediskencryption.cgi

Success

If the request is successful, disk encryption is disabled and a Success response is returned. See General success response.

Error

If an error occurred, an Error response is returned. See General error response.

Error codes: 10, 20, 40, 50, 100, 160

Use disks/properties/changediskpassphrase.cgi to change the passphrase used for disk encryption. The passphrase can only be changed when the disk is mounted. Changing the passphrase does not disrupt ongoing recordings.

Request

Access control

admin

Method

GET

http://<servername>/axis-cgi/disks/properties/changediskpassphrase.cgi?<argument>=<value>&[<argument>=<value>...]

with the following arguments and values:

Response

Responses from disks/properties/changediskpassphrase.cgi

Success

If the request is successful, disk encryption is disabled and a Success response is returned. See General success response.

Error

If an error occurred, an Error response is returned. See General error response.

Error codes: 10, 20, 40, 50, 100, 120, 130, 150

Use disks/properties/setcleanupmaxage.cgi to update the current cleanup max age setting.

Request

Access control

admin

Method

GET

http://<servername/axis-cgi/disks/properties/setcleanupmaxage.cgi?<argument=value>

Response

Responses from disks/properties/setcleanupmaxage.cgi

Success

If the request is successful, the disk content is encrypted and a Success response is returned. See General success response.

Error

If an error occurred, an Error response is returned. See General error response.

Error codes: 10, 20, 40, 50, 100, 110, 140, 160

Use disks/properties/setcleanuppolicy.cgi to update the current cleanup policy setting.

Request

Access control

admin

Method

GET

http://<servername/axis-cgi/disks/properties/setcleanuppolicy.cgi?<argument=value>

Response

Responses from disks/properties/setcleanuppolicy.cgi

Success

If the request is successful, the disk content is encrypted and a Success response is returned. See General success response.

Error

If an error occurred, an Error response is returned. See General error response.

Error codes: 10, 20, 40, 50, 100, 110, 140, 160

Use disks/properties/setdiskalertlevels.cgi to update the alert levels for a disk.

Request

Access control

admin

Method

GET

http://<servername>/axis-cgi/disks/properties/setdiskalertlevels.cgi?<argument=value>&[<argument=value>...]

with the following arguments and values:

Response

Responses from disks/properties/setdiskalertlevels.cgi

Success

If the request is successful, the disk content is encrypted and a Success response is returned. See General success response.

Error

If an error occurred, an Error response is returned. See General error response.

Error codes: 10, 20, 40, 50, 100, 110, 140, 160

Use disks/properties/getdiskalertlevels.cgi to check the alert levels for a disk.

Request

Access control

admin, operator

Method

GET

http://<servername>/axis-cgi/disks/properties/getdiskalertlevels.cgi?<argument=value>&[<argument=value>...]

with the following arguments and values:

Response

Responses from disks/properties/getdiskalertlevels.cgi

Success

HTTP/1.0 200 OK
Content-Type: text/xml

<DiskPropertiesResponse xmlns:xsi="http://www.w3.org/2001/XMLSchema-instance" xsi:noNamespaceSchemaLocation="http://www.axis.com/vapix/http_cgi/disks/properties/disk_properties1.xsd" SchemaVersion="1.1">
  <Success>
    <GetAlertLevelsSuccess>
      <AlertLevels Wear="50" Temperature="360"/>
    </GetAlertLevelsSuccess>
  </Success>
</DiskPropertiesResponse>

Error

If an error occurred, an Error response is returned. See General error response.

Error codes: 10, 20, 40, 50, 100, 110, 140, 160

Use disks/properties/schemaversions.cgi to list supported versions of the XML schema for the Disk properties API and whether the schemas are deprecated or not.

Request

Access control

admin, operator

Method

GET

http://<servername>/axis-cgi/disks/properties/schemaversions.cgi

This CGI has no arguments.

Response

Responses from disks/properties/schemaversions.cgi

HTTP code

200 OK

Content-type

text/xml

<?xml version="1.0" encoding="utf-8"?>
<DiskPropertiesResponse 
    xmlns="http://www.axis.com/vapix/http_cgi/disks/properties1" 
    xmlns:xsi="http://www.w3.org/2001/XMLSchema-instance" 
    xsi:schemaLocation=
    "http://www.axis.com/vapix/http_cgi/disks/properties1
    http://www.axis.com/vapix/http_cgi/disks/properties/disk_properties1.xsd"
    SchemaVersion="1.0">
  <Success>
    <SchemaVersionsSuccess>
      <SchemaVersion>
        <VersionNumber>[major.minor]</VersionNumber>
        <Deprecated>[true/false]</Deprecated>
        ...
      </SchemaVersion>
    </SchemaVersionsSuccess>
  </Success>
</DiskPropertiesResponse>

Supported elements, attributes and values:

General success response from Disk Properties API.

HTTP code

200 OK

Content-type

text/xml

<?xml version="1.0" encoding="UTF-8"?>
<DiskPropertiesResponse xmlns="http://www.axis.com/vapix/http_cgi/disks/properties1" xmlns:xsi="http://www.w3.org/2001/XMLSchema-instance" xsi:schemaLocation="http://www.axis.com/vapix/http_cgi/disks/properties1http://www.axis.com/vapix/http_cgi/disks/properties/disk_properties1.xsd" SchemaVersion="1.0">
  <Success>
    <GeneralSuccess />
  </Success>
</DiskPropertiesResponse>

Supported elements, attributes and values:

General error response from the Disk properties API.

HTTP code

200 OK

Content-type

text/xml

<?xml version="1.0" encoding="utf-8"?>
<DiskPropertiesResponse xmlns="http://www.axis.com/vapix/http_cgi/disks/properties1" xmlns:xsi="http://www.w3.org/2001/XMLSchema-instance" xsi:schemaLocation="http://www.axis.com/vapix/http_cgi/disks/properties1http://www.axis.com/vapix/http_cgi/disks/properties/disk_properties1.xsd" SchemaVersion="1.0">
  <Error>
    <GeneralError>
      <ErrorCode>[error code]</ErrorCode>
      <ErrorDescription>[description]</ErrorDescription>
    </GeneralError>
  </Error>
</DiskPropertiesResponse>

Supported elements, attributes and values:

Use VAPIX® Network share API to add, remove and manage network shares. A network share can be a share on a NAS (Network Attached Storage) or on any server that uses CIFS (Common Internet File System), also known as SMB (Server Message Block).

The Axis product identifies the share using a unique Share ID. The share ID is assigned to the share by the Axis product but can also be set manually when adding the share.

To store recordings on a network share, the share must be bound to a disk. The bind request returns a Disk ID which should be used when setting up and accessing recordings. For information about recordings, see Recording API.

The Network share API consists of the following CGIs:

Recordings stored on a network share cannot be accessed directly. This is because the Axis product creates an internal database on the share. If recordings need to be accessed directly, create a network share recipient in an action rule instead.

Identification

Use disks/networkshare/list.cgi to retrieve information about network shares used by the Axis product.

Request

Access control

admin, operator

Method

GET

http://<servername>/axis-cgi/disks/networkshare/list.cgi?<argument>=<value>[&<argument>=<value>...]

With the following arguments and values:

Response

The response from disks/networkshare/list.cgi is a list of network shares or a general error.

Success:

HTTP code

200 OK

Content-type

text/xml

<?xml version="1.0" encoding="utf-8"?>
<NetworkShareResponse SchemaVersion="1.0" xmlns:xsi="http://www.w3.org/2001/XMLSchema-instance" xsi:noNamespaceSchemaLocation="http://www.axis.com/vapix/http_cgi/networkshare1.xsd">
  <ListSuccess>
    <NetworkShares NumberOfShares="[number of shares]">
      <NetworkShare NiceName="[nicename 1]" 
        ShareId="[Share ID 1]"
        Address="[address 1]"
        Share="[share 1]"
        User="[user 1]"
        DiskId="[Disk ID 1]"/>
      ... 
    </NetworkShares>
  </ListSuccess>
</NetworkShareResponse>

Supported elements, attributes and values:

Error

If an error occurred, a GeneralError response is returned. See General error response.

Error codes: 10, 20, 40

Use disks/networkshare/add.cgi to add a network share.

Request

Access control

admin

Method

GET

http://<servername>/axis-cgi/disks/networkshare/add.cgi?<argument>=<value>[&<argument>=<value>...]

With the following arguments and values:

Response

Responses from disks/networkshare/add.cgi

Success:

HTTP code

200 OK

Content-type

text/xml

<?xml version="1.0" encoding="utf-8"?>
<NetworkShareResponse SchemaVersion="1.0" xmlns:xsi="http://www.w3.org/2001/XMLSchema-instance" xsi:noNamespaceSchemaLocation="http://www.axis.com/vapix/http_cgi/networkshare1.xsd">
  <AddSuccess ShareId="[Share ID]" />
</NetworkShareResponse>

Supported elements, attributes and values:

Error

If an error occurred, a GeneralError response is returned. See General error response.

Error codes: 10, 20, 40, 200, 210, 220, 230

Use disks/networkshare/remove.cgi to remove a network share from the product. Before removing, make sure that the network share is not bound. To unbound the share, use unbind.cgi, see Unbind network share.

Request

Access control

admin

Method

GET

http://<servername>/axis-cgi/disks/networkshare/remove.cgi?<argument>=<value>[&<argument>=<value>...]

With the following arguments and values:

Response

Responses from disks/networkshare/remove.cgi

Success

If the request is successful, disk encryption is disabled and a GeneralSuccess response is returned. See General success response.

Error

If an error occurred, a GeneralError response is returned. See General error response.

Error codes: 10, 20, 40, 500

Use disks/networkshare/modify.cgi to modify an existing network share. The user-friendly name NiceName can always be changed. To change the other parameters, the share must be unbound from the disk using unbind.cgi, see Unbind network share.

Request

Access control

admin

Method

GET

http://<servername>/axis-cgi/disks/networkshare/modify.cgi?<argument>=<value>[&<argument>=<value>...]

With the following arguments and values:

Response

Responses from disks/networkshare/modify.cgi

Success

If the request is successful, disk encryption is disabled and a GeneralSuccess response is returned. See General success response.

Error

If an error occurred, a GeneralError response is returned. See General error response.

Error codes: 10, 20, 40, 600, 610, 620

Use disks/networkshare/bind.cgi to bind an existing network share to a disk. This makes it possible to store recordings on the share and to access the share through the Disk management API. The request returns the Disk ID of the disk to which the share was bound. The Disk ID should be used when setting up and accessing recordings through the Recording API.

Request

Access control

admin, operator

Method

GET

http://<servername>/axis-cgi/disks/networkshare/bind.cgi?<argument>=<value>[&<argument>=<value>...]

With the following arguments and values:

Response

Responses from disks/networkshare/bind.cgi

Success

HTTP code

200 OK

Content-type

text/xml

<?xml version="1.0" encoding="utf-8"?>
<NetworkShareResponse SchemaVersion="1.0" xmlns:xsi="http://www.w3.org/2001/XMLSchema-instance" xsi:noNamespaceSchemaLocation="http://www.axis.com/vapix/http_cgi/networkshare1.xsd">
  <BindSuccess DiskID="[Disk ID]"/>
</NetworkShareResponse>

Supported elements, attributes and values:

Error

If an error occurred, a GeneralError response is returned. See General error response.

Error codes: 10, 20, 40, 300, 310

Use disks/networkshare/unbind.cgi to free a bound network share so that the share can be modified or removed.

Request

Access control

admin, operator

Method

GET

http://<servername>/axis-cgi/disks/networkshare/unbind.cgi?<argument>=<value>[&<argument>=<value>...]

With the following arguments and values:

Response

Responses from disks/networkshare/unbind.cgi

Success

If the request is successful, disk encryption is disabled and a GeneralSuccess response is returned. See General success response.

Error

If an error occurred, a GeneralError response is returned. See General error response.

Error codes: 10, 20, 40, 400

Use disks/networkshare/test.cgi to test a network share. The submitted parameters specifies the share to test. These parameters are only used to run the test and are not stored. The test checks if the network share can be used as a storage device.

The response shows if the job has been started or not. A successfully started job returns a Job ID, which should be used as input to job.cgi, see Job progress.

Request

Access control

admin, operator

Method

GET

http://<servername>/axis-cgi/disks/networkshare/test.cgi?<argument>=<value>[&<argument>=<value>...]

With the following arguments and values:

Response

Responses from disks/networkshare/test.cgi

Success

HTTP code

200 OK

Content-type

text/xml

<?xml version="1.0" encoding="utf-8"?>
<NetworkShareResponse SchemaVersion="1.0" xmlns:xsi="http://www.w3.org/2001/XMLSchema-instance" xsi:noNamespaceSchemaLocation="http://www.axis.com/vapix/http_cgi/networkshare1.xsd">
  <TestSuccess JobId="[Job ID]" />
</NetworkShareResponse>

Supported elements, attributes and values:

Error

If an error occurred, a GeneralError response is returned. See General error response.

Error codes: 10, 20, 40, 700, 710, 720, 730, 740, 750, 760

The disks/networkshare/job.cgi is used to check the progress of a test job.

The test job should be started by running test.cgi. If the job could be started successfully, a Job ID is returned. This Job ID is used as input to job.cgi. The Job ID can also be retrieved by running job.cgi.

Typically, job.cgi is run repeatedly until the job is finished. This workflow allows a user interface to be more responsive and to report the progress of a job by displaying incremental status updates, for example in a progress bar.

Request

Access control

admin, operator

Method

GET

http://<servername>/axis-cgi/disks/networkshare/job.cgi?<argument>=<value>[&<argument>=<value>...]

With the following arguments and values:

Response

Responses from disks/networkshare/job.cgi

Success: Job is in progress

HTTP code

200 OK

Content-type

text/xml

<?xml version="1.0" encoding="utf-8"?>
<NetworkShareResponse SchemaVersion="1.0" xmlns:xsi="http://www.w3.org/2001/XMLSchema-instance" xsi:noNamespaceSchemaLocation="http://www.axis.com/vapix/http_cgi/networkshare1.xsd">
  <JobSuccess>
    <Progress>[progress]</Progress>
  </JobSuccess>
</NetworkShareResponse>

Success: Job finished successfully

HTTP code

200 OK

Content-type

text/xml

<?xml version="1.0" encoding="utf-8"?>
<NetworkShareResponse SchemaVersion="1.0" xmlns:xsi="http://www.w3.org/2001/XMLSchema-instance" xsi:noNamespaceSchemaLocation="http://www.axis.com/vapix/http_cgi/networkshare1.xsd">
  <JobSuccess>
    <GeneralSuccess />
  </JobSuccess>
</NetworkShareResponse>

Success: Job finished but with errors

HTTP code

200 OK

Content-type

text/xml

<?xml version="1.0" encoding="utf-8"?>
<NetworkShareResponse SchemaVersion="1.0" xmlns:xsi="http://www.w3.org/2001/XMLSchema-instance" xsi:noNamespaceSchemaLocation="http://www.axis.com/vapix/http_cgi/networkshare1.xsd">
  <JobSuccess>
    <GeneralError>
      <ErrorCode>[code]</ErrorCode>
      <ErrorDescription>[description]</ErrorDescription>
    </GeneralError>
  </JobSuccess>
</NetworkShareResponse>

Supported elements, attributes and values:

Error

If an error occurred, a GeneralError response is returned. See General error response.

Error codes: 10, 20, 40, 700, 710, 720, 730, 740, 750, 760

Use disks/networkshare/schemaversions.cgi to list supported versions of the XML schema for the Network share API and whether the schemas are deprecated or not.

Request

Access control

admin, operator

Method

GET

http://<servername>/axis-cgi/disks/networkshare/schemaversions.cgi

This CGI has no arguments.

Response

Responses from disks/networkshare/schemaversions.cgi

HTTP code

200 OK

Content-type

text/xml

<?xml version="1.0" encoding="utf-8"?>
<NetworkShareResponse SchemaVersion="1.0" xmlns:xsi="http://www.w3.org/2001/XMLSchema-instance" xsi:noNamespaceSchemaLocation="http://www.axis.com/vapix/http_cgi/networkshare1.xsd">
  <SchemaVersionsSuccess>
    <SchemaVersion>
      <VersionNumber>[major1].[minor1]</VersionNumber>
      <Deprecated>[deprecated]</Deprecated>
      ...
    </SchemaVersion>
  </SchemaVersionsSuccess>
</NetworkShareResponse>

Supported elements, attributes and values:

General success response from Network Share API.

HTTP code

200 OK

Content-type

text/xml

<?xml version="1.0" encoding="utf-8"?>
<NetworkShareResponse SchemaVersion="1.0" xmlns:xsi="http://www.w3.org/2001/XMLSchema-instance" xsi:noNamespaceSchemaLocation="http://www.axis.com/vapix/http_cgi/networkshare1.xsd">
  <GeneralSuccess />
</NetworkShareResponse>

Supported elements, attributes and values:

General error response from Network share API.

HTTP code

200 OK

Content-type

text/xml

<?xml version="1.0" encoding="utf-8"?>
<NetworkShareResponse SchemaVersion="1.0" xmlns:xsi="http://www.w3.org/2001/XMLSchema-instance" xsi:noNamespaceSchemaLocation="http://www.axis.com/vapix/http_cgi/networkshare1.xsd">
  <GeneralError>
    <ErrorCode>[error code]</ErrorCode>
    <ErrorDescription>[description]</ErrorDescription>
  </GeneralError>
</NetworkShareResponse>

Supported elements, attributes and values:

VAPIX® Recording storage limit API allows applications to control how the capacity of a shared storage resource is distributed. For example, when several cameras record to the same network share, the API can be used to limit the amount of disk space each camera is allowed to use.

Setting recording storage limits is equivalent to setting up quota control on network-attached storage (NAS) devices. The Recording storage limit API enables applications to simplify recording and storage configuration by allowing the camera installer to configure storage limits at the same time and in the same application as the installer configures other recording and storage settings.

Supported functionality:

• Retrieve current recording storage limit and currently used disk space.

• Set recording storage limit.

Identification

Use record/storage/schemaversions.cgi to retrieve the supported XML schema versions.

Request

Access control

admin, operator

Method

GET

http://<servername>/axis-cgi/record/storage/schemaversions.cgi

This CGI has no arguments

Response

Responses from record/storage/schemaversions.cgi

Success

A successful request returns the supported schema versions.

HTTP code

200 OK

Content-type

text/xml

<?xml version="1.0" encoding="utf-8"?>
<StorageLimitsResponse xmlns:xsi="http://www.w3.org/2001/XMLSchema-instance" SchemaVersion="1.0" xsi:noNamespaceSchemaLocation="http://www.axis.com/vapix/http_cgi/recordingstoragelimit1.xsd">
  <SchemaVersionsSuccess>
    <SchemaVersion>
      <VersionNumber>[major.minor]</VersionNumber>
      <Deprecated>[true/false]</Deprecated>
    </SchemaVersion>
    <SchemaVersion>
      <VersionNumber>[major.minor]</VersionNumber>
      <Deprecated>[true/false]</Deprecated>
    </SchemaVersion>
      [...]
  </SchemaVersionsSuccess>
</StorageLimitsResponse>

Supported elements, attributes and values:

Error

If an error occurred, a GeneralError response is returned. See General error response.

Error codes: 10, 20, 40

Use record/storage/getlimit.cgi to retrieve the current recording storage limit.

Request

Access control

admin, operator

Method

GET

http://<servername>/axis-cgi/record/storage/getlimit.cgi?<argument>=<value>&[<argument>=<value>]

with the following arguments and values:

Response

Responses from record/storage/getlimit.cgi

Success

If the request is successful, the recording storage limit for the specified disks is returned.

HTTP code

200 OK

Content-type

text/xml

<?xml version="1.0" encoding="utf-8"?>
<StorageLimitsResponse xmlns:xsi="http://www.w3.org/2001/XMLSchema-instance" SchemaVersion="1.0" xsi:noNamespaceSchemaLocation="http://www.axis.com/vapix/http_cgi/recordingstoragelimit1.xsd">
  <GetStorageLimitsResponse>
    <StorageLimit diskid="[Disk ID]" size="[size]" usedspace="[used size]" />
    <StorageLimit diskid="[Disk ID]" size="[size]" usedspace="[used size]" />
  </GetStorageLimitsResponse>
</StorageLimitsResponse>

Supported elements, attributes and values:

Error

If an error occurred, a GeneralError response is returned. See General error response.

Error codes: 10, 20, 40, 110

Use record/storage/setlimit.cgi to set the recording storage limit, that is, the amount of disk space the Axis product is allowed to use.

Request

Access control

admin, operator

Method

GET

http://<servername>/axis-cgi/record/storage/setlimit.cgi?<argument>=<value>&[<argument>=<value>]

with the following arguments and values:

Response

Responses from record/storage/setlimit.cgi

Success

If the request is successful, the recording storage limit is set and a GeneralSuccess response is returned. See General success response.

Error

If an error occurred, a GeneralError response is returned. See General error response.

Error codes: 10, 20, 40, 110, 120, 130

General success response from Recording storage limit API.

HTTP code

200 OK

Content-type

text/xml

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

Supported elements, attributes and values:

General error response from Recording storage limit API.

HTTP code

200 OK

Content-type

text/xml

<?xml version="1.0" encoding="utf-8"?>
<StorageLimitsResponse xmlns:xsi="http://www.w3.org/2001/XMLSchema-instance" SchemaVersion="1.0" xsi:noNamespaceSchemaLocation="http://www.axis.com/vapix/http_cgi/recordingstoragelimit1.xsd">
  <GeneralError>
    <ErrorCode>[error code]</ErrorCode>
    <ErrorDescription>[description]</ErrorDescription>
  </GeneralError>
</StorageLimitsResponse>

Supported elements, attributes and values:

The Recording API is used for recording management. Recordings can be listed, played, stopped and removed. Continuous recordings can be started and stopped. Each recording is identified by a unique Recording ID.

Recordings are stored on disks, for example SD cards and network shares. Disks are handled by the Disk Management API, see Disk management API.

The Recording API is used to start and stop continuous recordings. Axis products also support event-triggered and scheduled recordings. These are configured using VAPIX® Event and Action Services, see Event and action services.

If the Axis product supports continuous recording profiles (parameter Properties.LocalStorage.ContinuousRecording is set to yes), a continuous recording should be configured using addconfiguration.cgi.

To play recordings, use media.amp from the RTSP API. Using RTSP for playback is recommended because all video formats as well as audio and video synchronization is supported. MJPEG recordings can also be played using play.cgi from the HTTP API.

The Recording API consists of:

Recordings can be exported using the Export Recording API. See Export recording API.

The date and time format used in the Recording API is the UTC combined date and time format defined in ISO 8601:

<yyyy>-<mm>-<dd>T<HH>:<MM>:<SS>Z

If required, the fraction of a second .<mmmm> can also be used:

<yyyy>-<mm>-<dd>T<HH>:<MM>:<SS>.<mmmm>Z

The time offset from UTC can also be included:

<yyyy>-<mm>-<dd>T<HH>:<MM>:<SS>.<mmmm>±hh:mm

When using the clock option with the Range header in RTSP requests, the following date and time formats should be used:

<yyyy><mm><dd>T<HH><MM><SS>[.<mmmm>]Z

The Range header also supports NPT and SMPTE times, see Play recording using RTSP.

Identification

Recording default parameters

The parameters in the Recording group define default recording settings.

The record/continuous/addconfiguration.cgi is used to configure a continuous recording. The recording will be started when possible.

An existing recording profile cannot be changed. To change settings, the profile must be removed and replaced with a new recording profile.

This CGI is available if Properties.LocalStorage.ContinuousRecording=yes and Properties.LocalStorage.ContinuousRecordingProfiles > 0.

Request

Access control

admin, operator

Method

GET

http://<servername>/axis-cgi/record/continuous/addconfiguration.cgi?
<argument>=<value>[&<argument>=<value>...]

With the following arguments and values:

Response

Responses from record/continuous/addconfiguration.cgi

Success:

HTTP code

200 OK

Content-type

text/xml

<?xml version="1.0" ?>
<root xmlns:xsi="http://www.w3.org/2001/XMLSchema-instance" 
    xsi:noNamespaceSchemaLocation=
    "http://www.axis.com/vapix/http_cgi/recording/continuousconfigurationadd1.xsd">
  <configure profile="[profile number]" 
         result="OK" />
  ...
</root>

Error:

HTTP code

200 OK

Content-type

text/xml

<?xml version="1.0" ?>
<root xmlns:xsi="http://www.w3.org/2001/XMLSchema-instance" 
    xsi:noNamespaceSchemaLocation=
    "http://www.axis.com/vapix/http_cgi/recording/continuousconfigurationadd1.xsd">
  <configure profile="[profile number]"
         result="ERROR" 
         errormsg="[error description]" />
  ...
</root>

Supported elements, attributes and values:

The record/continuous/listconfiguration.cgi is used to list information about continuous recording profiles.

Request

Access control

admin, operator, viewer

Method

GET

http://<servername>/axis-cgi/record/continuous/listconfiguration.cgi?
<argument>=<value>[&<argument>=<value>...]

With the following arguments and values:

Response

Responses from record/continuous/listconfiguration.cgi

Success:

HTTP code

200 OK

Content-type

text/xml

<?xml version="1.0" ?>
<root xmlns:xsi="http://www.w3.org/2001/XMLSchema-instance" 
    xsi:noNamespaceSchemaLocation=
    "http://www.axis.com/vapix/http_cgi/recording/continuousconfigurationlist1.xsd">
  <continuousrecordingconfigurations>
    <continuousrecordingconfiguration profile="[profile number]"
          diskid="[disk ID]"
          options="[stream options]"
          eventid="[event ID]" />
    ...
  </continuousrecordingconfigurations>
</root>

Supported elements, attributes and values:

The record/continuous/removeconfiguration.cgi is used to stop and remove a continuous recording profile.

Request

Access control

admin, operator

Method

GET

http://<servername>/axis-cgi/record/continuous/removeconfiguration.cgi?
<argument>=<value>[&<argument>=<value>...]

With the following arguments and values:

Response

Responses from record/continuous/removeconfiguration.cgi

Success:

HTTP code

200 OK

Content-type

text/xml

<?xml version="1.0" ?>
<root xmlns:xsi="http://www.w3.org/2001/XMLSchema-instance" 
    xsi:noNamespaceSchemaLocation="
    http://www.axis.com/vapix/http_cgi/recording/continuousconfigurationremove1.xsd">
  <remove profile="[profile number]" 
         result="OK" />
  ...
</root>

Error:

HTTP code

200 OK

Content-type

text/xml

<?xml version="1.0" ?>
<root xmlns:xsi="http://www.w3.org/2001/XMLSchema-instance" 
    xsi:noNamespaceSchemaLocation="
    http://www.axis.com/vapix/http_cgi/recording/continuousconfigurationremove1.xsd">
  <remove profile="[profile number]"
         result="ERROR" 
         errormsg="[error description]" />
  ...
</root>

Supported elements, attributes and values:

The record/list.cgi is used to search for recordings and list information about found recordings.

Request

Access control

admin, operator, viewer

Method

GET/POST

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

With the following arguments and values:

Response

The response from record/list.cgi depends on the submitted listentity.

List recording IDs — Success

The following response is returned if listentity=recordingid.

HTTP code

200 OK

Content-type

text/xml

<?xml version="1.0" ?>
<root xmlns:xsi="http://www.w3.org/2001/XMLSchema-instance" 
    xsi:noNamespaceSchemaLocation=
    "http://www.axis.com/vapix/http_cgi/recording/list1.xsd">
  <recordings totalnumberofrecordings="[the number of recordings in all attached disks]" 
       numberofrecordings="[the number of matched recordings]" >
    <recording  diskid="[Disk ID]"
      recordingid="[Recording ID]" 
      starttime="[UTC start time]" 
      starttimelocal="[Local start time]" 
      stoptime="[UTC stop time or empty string]" 
      stoptimelocal="[Local stop time or empty string]" 
      recordingtype="[Triggered, scheduled or continuous recording]" 
      eventid="[Name of the event that initiated the recording]" 
      eventtrigger="[Software input for the event that initiated the recording]" 
      recordingstatus="[Recording is active or inactive]" 
      source="[Recording source]"> 
      <video mimetype="[video mime type]" 
        source="[video source]" 
        framerate="[frame rate]" 
        resolution="[resolution]" 
        width="[width]" 
        height="[height]" /> 
      <audio mimetype="[audio mime type]" 
        source="[audio source]" 
        bitrate="[bit rate]" 
        samplerate="[sample rate]" />
    </recording> 
  </recordings> 
</root>

Supported elements, attributes and values:

List event IDs — Success

The following response is returned if listentity=eventid.

HTTP code

200 OK

Content-type

text/xml

<?xml version="1.0" ?>
<root xmlns:xsi="http://www.w3.org/2001/XMLSchema-instance" 
    xsi:noNamespaceSchemaLocation=
    "http://www.axis.com/vapix/http_cgi/recording/list1.xsd">
  <eventids>
    <eventid>"[Event name]" </eventid>
    ...
  </eventids> 
</root>

Supported elements, attributes and values:

List sources — Success

If listentity=source, the response lists the sources in which recordings were found.

HTTP code

200 OK

Content-type

text/xml

<?xml version="1.0" ?>
<root xmlns:xsi="http://www.w3.org/2001/XMLSchema-instance" 
    xsi:noNamespaceSchemaLocation=
    "http://www.axis.com/vapix/http_cgi/recording/list1.xsd">
  <sources>
    <source>[Source]" </source>
    ...
  </sources> 
</root>

Supported elements, attributes and values:

The record/record.cgi is used to start a recording. The recording will start at once and a recording ID will be returned.

The recording must be stopped by calling stop.cgi, see Stop recording.

Request

Access control

admin, operator

Method

GET

http://<servername>/axis-cgi/record/record.cgi?<argument>=<value>
[&<argument>=<value>...]

With the following arguments and values:

Response

Responses from record/record.cgi

Success:

HTTP code

200 OK

Content-type

text/xml

<?xml version="1.0" ?>
<root xmlns:xsi="http://www.w3.org/2001/XMLSchema-instance" 
    xsi:noNamespaceSchemaLocation=
    "http://www.axis.com/vapix/http_cgi/recording/record1.xsd">
  <record recordingid="[Recording ID]" 
         result="OK" />
  ...
</root>

Error:

HTTP code

200 OK

Content-type

text/xml

<?xml version="1.0" ?>
<root xmlns:xsi="http://www.w3.org/2001/XMLSchema-instance" 
    xsi:noNamespaceSchemaLocation=
    "http://www.axis.com/vapix/http_cgi/recording/record1.xsd">
  <record 
         result="ERROR" 
         errormsg="[error description]" />
  ...
</root>

Supported elements, attributes and values:

The record/stop.cgi is used to stop an active recording.

Request

Access control

admin, operator

Method

GET

http://<servername>/axis-cgi/record/stop.cgi?<argument>=<value>
[&<argument>=<value>...]

With the following arguments and values:

Response

Responses from record/stop.cgi

Success:

HTTP code

200 OK

Content-type

text/xml

<?xml version="1.0" ?>
<root xmlns:xsi="http://www.w3.org/2001/XMLSchema-instance" 
    xsi:noNamespaceSchemaLocation=
    "http://www.axis.com/vapix/http_cgi/recording/stop1.xsd">
  <stop recordingid="[Recording ID]" 
         result="OK" />
  ...
</root>

Error:

HTTP code

200 OK

Content-type

text/xml

<?xml version="1.0" ?>
<root xmlns:xsi="http://www.w3.org/2001/XMLSchema-instance" 
    xsi:noNamespaceSchemaLocation=
    "http://www.axis.com/vapix/http_cgi/recording/stop1.xsd">
  <stop recordingid="[Recording ID]" 
         result="ERROR" 
         errormsg="[error description]" />
  ...
</root>

Supported elements, attributes and values:

The record/remove.cgi is used to remove one or more recordings.

Request

Access control

admin, operator

Method

GET

http://<servername>/axis-cgi/record/remove.cgi?<argument>=<value>
[&<argument>=<value>...]

With the following arguments and values:

Response

Responses from record/remove.cgi

Success:

HTTP code

200 OK

Content-type

text/xml

<?xml version="1.0" ?>
<root xmlns:xsi="http://www.w3.org/2001/XMLSchema-instance" 
    xsi:noNamespaceSchemaLocation=
    "http://www.axis.com/vapix/http_cgi/recording/remove1.xsd">
  <remove recordingid="[Recording ID]" 
         result="OK" />
  ...
</root>

Error:

HTTP code

200 OK

Content-type

text/xml

<?xml version="1.0" ?>
<root xmlns:xsi="http://www.w3.org/2001/XMLSchema-instance" 
    xsi:noNamespaceSchemaLocation=
    "http://www.axis.com/vapix/http_cgi/recording/remove1.xsd">
  <remove recordingid="[Recording ID]" 
         result="ERROR" 
         errormsg="[error description]" />
  ...
</root>

Supported elements, attributes and values:

The record/play.cgi has been deprecated and will no longer receive updates.

The record/play.cgi is used to play a MJPEG recording as a stream. The format will be the same as the live view stream.

Only MJPEG recordings can be played using this method. H.264 and MPEG-4 recordings must be played using RTSP, see Play recording using RTSP.

If possible, use the RTSP playback method. RTSP supports all video formats and synchronization of video and audio.

Request

Access control

admin, operator, viewer

Method

GET

http://<servername>/axis-cgi/record/play.cgi?<argument>=<value>
[&<argument>=<value>...]

With the following arguments and values:

Recordings in all media formats, with video and audio synchronization, can be played using the RTSP API.

When playing MJPEG , the maximum resolution is 2040x2040.

Request

Access control

admin, operator, viewer

PLAY rtsp://<servername>/axis-media/media.amp?<parameter>=<value>
[&<parameter>=<value>...]
Headerfield1: val1<CRLF>
Headerfield2: val2<CRLF>
Range: [npt|clock|smpte]=<starttime>-<stoptime><CRLF>
...
<CRLF>
 
[Body]

With the following RTSP parameters values:

The following additional header field is accepted when playing a recording:

Refer to the RTSP API for additional header fields and RTSP parameters.

VAPIX® Export recording API is used to export an edge storage recording to a single playable file. It is possible to export a complete recording or to export a part of a recording (a video clip). The exported recording is a Matroska (.mkv) file and can be exported in an encrypted ZIP archive.

Supported functionality:

• Retrieve supported capabilities.

• Retrieve recording export properties such as start time, stop time and estimated file size. Recording export properties should be retrieved before exporting the recording.

• Export recording.

Identification

Get supported XML schema versions

http://<servername>/axis-cgi/record/export/schemaversions.cgi

HTTP/1.0 200 OK
Content-Type: text/xml
 
<?xml version="1.0" encoding="utf-8"?>
<ExportRecordingResponse xmlns:xsi="http://www.w3.org/2001/XMLSchema-instance" SchemaVersion="1.2" xsi:noNamespaceSchemaLocation="http://www.axis.com/vapix/http_cgi/exportrecording1.xsd">
  <SchemaVersionsSuccess>
    <SchemaVersion>
      <VersionNumber>1.0</VersionNumber>
      <Deprecated>false</Deprecated>
    </SchemaVersion>
    <SchemaVersion>
      <VersionNumber>1.1</VersionNumber>
      <Deprecated>false</Deprecated>
    </SchemaVersion>
    <SchemaVersion>
      <VersionNumber>1.2</VersionNumber>
      <Deprecated>false</Deprecated>
    </SchemaVersion>
  </SchemaVersionsSuccess>
</ExportRecordingResponse>

Get export capabilities

http://<servername>/axis-cgi/record/export/capabilities.cgi?schemaversion=1

HTTP/1.0 200 OK
Content-Type: text/xml
 
<?xml version="1.0" encoding="utf-8"?>
<ExportRecordingResponse xmlns:xsi="http://www.w3.org/2001/XMLSchema-instance" SchemaVersion="1.2" xsi:noNamespaceSchemaLocation="http://www.axis.com/vapix/http_cgi/exportrecording1.xsd">
  <CapabilitiesSuccess>
    <ExportCapabilities ExportFormat="matroska">
      <ExportEncryption EncryptionFormat="zip-aes256"/>
    </ExportCapabilities>
  </CapabilitiesSuccess>
</ExportRecordingResponse>

Get Recording ID

http://<servername>/axis-cgi/record/list.cgi?recordingid=all

HTTP/1.0 200 OK
Content-Type: text/xml
 
<?xml version="1.0" encoding="utf-8"?>
<root xmlns:xsi="http://www.w3.org/2001/XMLSchema-instance" xsi:noNamespaceSchemaLocation= "http://www.axis.com/vapix/http_cgi/recording/list1.xsd">
  <recordings totalnumberofrecordings="30" numberofrecordings="30" >
    <recording diskid="SD_DISK" recordingid="20141211_091153_025B_00408CCAD5D78" ... >
      <video ... />
      <audio ... />
    </recording>
    ...
  <recordings>
</root>

Get recording export properties

http://<servername>/axis-cgi/record/export/properties.cgi?schemaversion=1
&recordingid=20141211_091153_025B_00408CCAD5D78&diskid=SD_DISK

HTTP/1.0 200 OK
Content-Type: text/xml
 
<?xml version="1.0" encoding="utf-8"?>
<ExportRecordingResponse xmlns:xsi="http://www.w3.org/2001/XMLSchema-instance" SchemaVersion="1.1" xsi:noNamespaceSchemaLocation="http://www.axis.com/vapix/http_cgi/exportrecording1.xsd">
  <PropertiesSuccess>
    <ExportProperties RecordingId="20141211_091153_025B_00408CCAD5D78" ExportFormat="matroska" EstimatedFileSize="1234" Starttime="2014-12-11T09:11:52Z" Stoptime="2014-12-11T11:00:46Z"/>
  </PropertiesSuccess>
</ExportRecordingResponse>

http://<servername>/axis-cgi/record/export/properties.cgi?schemaversion=1
&recordingid=20141211_091153_025B_00408CCAD5D78&diskid=SD_DISK
&starttime=2014-12-11T09:45:11Z&stoptime=2014-12-11T10:10:00Z

HTTP/1.0 200 OK
Content-Type: text/xml
 
<?xml version="1.0" encoding="utf-8"?>
<ExportRecordingResponse xmlns:xsi="http://www.w3.org/2001/XMLSchema-instance" SchemaVersion="1.1" xsi:noNamespaceSchemaLocation="http://www.axis.com/vapix/http_cgi/exportrecording1.xsd">
  <PropertiesSuccess>
    <ExportProperties RecordingId="20141211_091153_025B_00408CCAD5D78" ExportFormat="matroska" EstimatedFileSize="1234" Starttime="2014-12-11T09:45:09Z" Stoptime="2014-12-11T10:10:00Z"/>
  </PropertiesSuccess>
</ExportRecordingResponse>

http://<servername/axis-cgi/record/export/properties.cgi?schemaversion=1&recordingid=20121211_091153_025B_00408CCAD5D78&diskid=SD_DISK&encryptionformat=zip-aes256

<?xml version="1.0" encoding="utf-8"?>
<ExportRecordingResponse SchemaVersion="1.2" xmlns:xsi="http://www.w3.org/2001/XMLSchema-instance" xsi:noNamespaceSchemaLocation="http://www.axis.com/vapix/http_cgi/exportrecording1.xsd">
  <PropertiesSuccess>
    <ExportProperties RecordingId="20121211_091153_025B_00408CCAD5D78" ExportFormat="matroska" EncryptionFormat="zip-aes256" EstimatedFileSize="1234" Starttime="2012-12-11T09:11:52Z" Stoptime="2012-12-11T10:10:00Z"/>
  </PropertiesSuccess>
</ExportRecordingResponse>

Export the recording

http://<servername>/axis-cgi/record/export/exportrecording.cgi?schemaversion=1
&recordingid=20141211_091153_025B_00408CCAD5D78&diskid=SD_DISK
&exportformat=matroska

HTTP/1.0 200 OK
Content-Disposition: attachment; filename="20141211_0911531234_20141211_1234565678.mkv"
Content-Type: video/x-matroska
 
<file data>

http://<servername>/axis-cgi/record/export/exportrecording.cgi?schemaversion=1
&recordingid=20141211_091153_025B_00408CCAD5D78&diskid=SD_DISK
&exportformat=matroska
&starttime=2014-12-11T09:45:09Z&stoptime=2014-12-11T10:10:00Z

HTTP/1.0 200 OK
Content-Disposition: attachment; filename="20141211_0945091234_20141211_1010565678.mkv"
Content-Type: video/x-matroska
 
<file data>

http://<servername/axis-cgi/record/export/exportrecording.cgi?schemaversion=1&recordingid=20121211_091153_025B_00408CCAD5D78&diskid=SD_DISK&exportformat=matroska&starttime=2012-12-11T09:45:09Z&stoptime=2012-12-11T10:10:00Z

HTTP/1.0 200 OK
Content-disposition: attachment; filename="20121211_0945091234_20121211_1010005678.mkv"
Content-Type: video/x-matroska

<file data>

http://<servername>/axis-cgi/record/export/exportrecording.cgi?schemaversion=1
&recordingid=20141211_121153_025B_00408CCAD5D78&diskid=SD_DISK
&exportformat=matroska

HTTP/1.0 200 OK
Content-disposition: attachment; filename="20141211_1211531234_20141212_1415435678.mkv"
Content-Type: video/x-matroska
 
<file data>

http://<servername>/axis-cgi/record/export/exportrecording.cgi?schemaversion=1
&recordingid=20141211_121153_025B_00408CCAD5D78&diskid=SD_DISK
&exportformat=matroska&filename=my_file

HTTP/1.0 200 OK
Content-disposition: attachment; filename="my_file.mkv"
Content-Type: video/x-matroska
 
<file data>

http://<servername>/axis-cgi/record/export/exportrecording.cgi?schemaversion=1&recordingid=20121211_091153_025B_00408CCAD5D78&diskid=SD_DISK&exportformat=matroska&password=pass_1&encryptionformat=zip-aes256&filename=encrypted_video

HTTP/1.0 200 OK
Content-disposition: attachment; filename="encrypted_video.zip"
Content-Type: application/zip

<ZIP file data>

http://<servername/axis-cgi/record/export/exporttoexternal.cgi?schemaversion=1&recordingid=20121211_091153_025B_00408CCAD5D78&diskid=SD_DISK&exportformat=matroska&starttime=2012-12-11T09:45:09Z&stoptime=2012-12-11T10:10:00Z&externaldiskid=USB_DISK&filepath=video.mkv

<?xml version="1.0" encoding="utf-8"?>
<ExportRecordingResponse SchemaVersion="1.2" xmlns:xsi="http://www.w3.org/2001/XMLSchema-instance" xsi:noNamespaceSchemaLocation="http://www.axis.com/vapix/http_cgi/exportrecording1.xsd">
  <ExportToExternalSuccess>
    <ExportToExternal JobId="1" FilePath="video.mkv"/>
  </ExportToExternalSuccess>
</ExportRecordingResponse>

http://<servername/axis-cgi/record/export/getjobstatus.cgi?schemaversion=1&jobid=1

<?xml version="1.0" encoding="utf-8"?>
<ExportRecordingResponse SchemaVersion="1.2" xmlns:xsi="http://www.w3.org/2001/XMLSchema-instance" xsi:noNamespaceSchemaLocation="http://www.axis.com/vapix/http_cgi/exportrecording1.xsd">
  <GetJobStatusSuccess>
    <JobStatus Status="In Progress" Progress="45"/>
  </GetJobStatusSuccess>
</ExportRecordingResponse>

Get schema versions

http://<servername>/axis-cgi/record/export/schemaversions.cgi

<?xml version="1.0" encoding="utf-8"?>
<ExportRecordingResponse xmlns:xsi="http://www.w3.org/2001/XMLSchema-instance" SchemaVersion="1.1" xsi:noNamespaceSchemaLocation="http://www.axis.com/vapix/http_cgi/exportrecording1.xsd">
  <SchemaVersionsSuccess>
    <SchemaVersion>
      <VersionNumber>[major.minor]</VersionNumber>
      <Deprecated>[true/false]</Deprecated>
    </SchemaVersion>
    <SchemaVersion>
      <VersionNumber>[major.minor]</VersionNumber>
      <Deprecated>[true/false]</Deprecated>
    </SchemaVersion>
      [...]
  </SchemaVersionsSuccess>
</ExportRecordingResponse>

Get capabilities

http://<servername>/axis-cgi/record/export/capabilities.cgi?<argument>=<value>

<?xml version="1.0" encoding="utf-8"?>
<ExportRecordingResponse xmlns:xsi="http://www.w3.org/2001/XMLSchema-instance" SchemaVersion="1.1" xsi:noNamespaceSchemaLocation="http://www.axis.com/vapix/http_cgi/exportrecording1.xsd">
  <CapabilitiesSuccess>
    <ExportCapabilities ExportFormat="[Format 1]"/>
    <ExportCapabilities ExportFormat="[Format 2]"/>
    ...
  </CapabilitiesSuccess>
</ExportRecordingResponse>

Get export properties

http://<servername>/axis-cgi/record/export/properties.cgi?<argument>=<value>&[<argument>=<value>...]

<?xml version="1.0" encoding="utf-8"?>
<ExportRecordingResponse SchemaVersion="1.2" xmlns:xsi="http://www.w3.org/2001/XMLSchema-instance" xsi:noNamespaceSchemaLocation="http://www.axis.com/vapix/http_cgi/exportrecording1.xsd">
  <PropertiesSuccess>
    <ExportProperties RecordingId="[Recording ID]" ExportFormat="[Format]" EncryptionFormat="[Encryption format]" EstimatedFileSize="[File size]" Starttime="[Start time]" Stoptime="[Stop time]"/>
  </PropertiesSuccess>
</ExportRecordingResponse>

Export recording

http://<servername>/axis-cgi/record/export/exportrecording.cgi?<argument>=<value>&[<argument>=<value>...]

HTTP/1.0 200 OK
Content-disposition: attachment; filename="20121219_123456_20121220_123456.mkv"
Content-Type: video/x-matroska

<file data>

HTTP/1.0 200 OK
Content-disposition: attachment; filename="XXXXXX.zip"
Content-Type: application/zip

<file data>

Export a recording to an external disk

http://<servername/axis-cgi/record/export/exporttoexternal.cgi?<argument>=<value>

<?xml version="1.0" encoding="utf-8"?>
<ExportRecordingResponse SchemaVersion="1.2" xmlns:xsi="http://www.w3.org/2001/XMLSchema-instance" xsi:noNamespaceSchemaLocation="http://www.axis.com/vapix/http_cgi/exportrecording1.xsd">
  <ExportToExternalSuccess>
    <ExportToExternal JobId="[jobid1]" FilePath="[filepath1]"/>
  </ExportToExternalSuccess>
</ExportRecordingResponse>

<?xml version="1.0" encoding="utf-8"?>
<ExportRecordingResponse SchemaVersion="1.2" xmlns:xsi="http://www.w3.org/2001/XMLSchema-instance" xsi:noNamespaceSchemaLocation="http://www.axis.com/vapix/http_cgi/exportrecording1.xsd">
  <GeneralError>
    <ErrorCode>[code]</ErrorCode>
    <ErrorDescription>[description]</ErrorDescription>
  </GeneralError>
</ExportRecordingResponse>

Get job status

http://<servername/axis-cgi/record/export/getjobstatus.cgi?<argument>=<value>

<?xml version="1.0" encoding="utf-8"?>
<ExportRecordingResponse SchemaVersion="1.2" xmlns:xsi="http://www.w3.org/2001/XMLSchema-instance" xsi:noNamespaceSchemaLocation="http://www.axis.com/vapix/http_cgi/exportrecording1.xsd">
  <GetJobStatusSuccess>
    <JobStatus Status="[status]" Progress="[progress]"/>
  </GetJobStatusSuccess>
</ExportRecordingResponse>

<?xml version="1.0" encoding="utf-8"?>
<ExportRecordingResponse SchemaVersion="1.2" xmlns:xsi="http://www.w3.org/2001/XMLSchema-instance" xsi:noNamespaceSchemaLocation="http://www.axis.com/vapix/http_cgi/exportrecording1.xsd">
  <GetJobStatusSuccess>
    <GeneralError>
      <ErrorCode>[code]</ErrorCode>
      <ErrorDescription>[description]</ErrorDescription>
    </GeneralError>
  </GetJobStatusSuccess>
</ExportRecordingResponse>

<?xml version="1.0" encoding="utf-8"?>
<ExportRecordingResponse SchemaVersion="1.2" xmlns:xsi="http://www.w3.org/2001/XMLSchema-instance" xsi:noNamespaceSchemaLocation="http://www.axis.com/vapix/http_cgi/exportrecording1.xsd">
  <GeneralError>
    <ErrorCode>[code]</ErrorCode>
    <ErrorDescription>[description]</ErrorDescription>
  </GeneralError>
</ExportRecordingResponse>

General error response

<?xml version="1.0" encoding="utf-8"?>
<ExportRecordingResponse xmlns:xsi="http://www.w3.org/2001/XMLSchema-instance" SchemaVersion="1.1" xsi:noNamespaceSchemaLocation="http://www.axis.com/vapix/http_cgi/exportrecording1.xsd">
  <GeneralError>
    <ErrorCode>[error code]</ErrorCode>
    <ErrorDescription>[description]</ErrorDescription>
  </GeneralError>
</ExportRecordingResponse>

The Recording ongoing event is emitted when there is an ongoing recording to an edge storage device.

Topic

Name

tnsaxis:Storage/tnsaxis:Recording

Type

Stateful

Nice name

Recording ongoing

Source instance

None

Data instance

Nice name

Recording ongoing

Type

boolean

Name

recording

isPropertyState

true

The Storage disruption detection event is true when there is a problem with a storage device.

The event is emitted with data instance disruption set to true in the following situations: storage is unmounted, storage is mounted in read-only mode, on read/write errors, storage is removed, storage is full, storage is locked.

The event is emitted with data instance disruption set to false in the following situations: storage is mounted successfully with read/write permissions, a storage that was locked has been unlocked, data has been successfully removed so that the storage is no longer full.

Use disks/checkdisk.cgi and/or disks/list.cgi to troubleshoot storage problems.

Topic

Name

tnsaxis:Storage/tnsaxis:Disruption

Type

Stateful

Nice name

Storage Disruption

Source instance

Name:

disk_id

Type

string

Nice name

Disk

Data instance

Nice name

Storage Disruption

Type

boolean

Name

disruption

isPropertyState

true

Use the Record Video action to record video to a storage device, for example an SD card or a network share. For information about how to retrieve recordings, see Recording API.

This action can be run as:

• fixed action — video is recorded during a pre-event and post-event time

• unlimited action — video is recorded during a pre-event time, while the event is running and during a post-event time

Action ID

com.axis.action.fixed.recording.storage

Action ID

com.axis.action.unlimited.recording.storage

By using this action along with Recording group allows you to record video to a recording group, for example on an SD card or a network share. This is useful when you want to set up a recording group that with multiple actions creates a single recording, even when two or more actions are active in parallel.

This action can be run as:

• unlimited action — video is recorded during a pre-duration time, while the event is running and during a post-duration time.

Action ID

com.axis.action.unlimited.recording_group.storage