Skip to main content

Log API

The VAPIX® Log API makes it possible to manage personalized log configurations on your Axis device. With it, you will be able to:

  • Turn on/off saving logs to the persistent storage and check the current status.
  • Clear log content from the persistent storage.
  • Write messages into the system log.

These calls allow the users to save logs during a set time frame without having to care about log rotation or camera rebooting and to write messages into existing logs.

The log file can be retrieved through /axis-cgi/serverreport.cgi with option tar_all. Request to CGI with this option can get all log files from the camera.

info

Saving logs to the persistent storage shouldn't always be turned on, since the persistent storage will become full. Free up device space by clearing the persistent log.

info

Avoid writing many large messages during a short period of time, since this can overflow the storage space.

Overview​

This API is based on the Device Configuration API framework. For guidance on how to use these APIs, please refer to Device Configuration APIs.

Authentication​

For detailed information on how to authenticate requests to this API, please refer to Authentication.

Use cases​

Save logs to the persistent storage​

Capture logs between boot sessions. This is achieved by:

  1. Turn on saving logs to the persistent storage.

  2. Reboot device (through /axis-cgi/firmwaremanagement.cgi with method Reboot).

  3. Turn off saving logs to the persistent storage.

  4. Retrieve the log file on the persistent storage (through /axis-cgi/serverreport.cgi with option tar_all).

  5. Clear log file on the persistent storage to free up device space.

Logs of all severity levels are saved to the persistent storage.

Turn on/off the saving of logs to the persistent storage​

enabled is set to true or false to turn on/off the saving of logs to the persistent storage. The following example will show you how to turn on the saving of logs to the persistent storage.

Example

curl --request PATCH \
  --anyauth \
  --user "<username>:<password>" \
  --header "Content-Type: application/json" \
  "http://<servername>/config/rest/log/v1/persistent/enabled" \
  --data '{
  "data": true
}'
200 OK
Content-Type: application/json

{
  "status": "success"
}

Check status of saving logs to the persistent storage​

Get the value of enabled to check whether the logging to the persistent storage is turned on.

Example

curl --request GET \
  --anyauth \
  --user "<username>:<password>" \
  --header "Content-Type: application/json" \
  "http://<servername>/config/rest/log/v1/persistent/enabled"
200 OK
Content-Type: application/json

{
  "status": "success",
  "data": true
}

Clear the log file from the persistent storage​

Trigger the action to clear the log file.

Example

curl --request POST \
  --anyauth \
  --user "<username>:<password>" \
  --header "Content-Type: application/json" \
  "http://<servername>/config/rest/log/v1/persistent/clearLog" \
  --data '{
  "data": {}
}'
200 OK
Content-Type: application/json

{
  "status": "success"
}

Write message into the system log​

Write a message into the system log with a user selected severity level.

Example

curl --request POST \
  --anyauth \
  --user "<username>:<password>" \
  --header "Content-Type: application/json" \
  "http://<servername>/config/rest/log/v1/writeMessage" \
  --data '{
  "data": {
    "msg": "message",
    "severity": 7
  }
}'
200 OK
Content-Type: application/json

{
  "status": "success"
}

API definition​

Structure​

log.v1 (Root Entity)
  writeMessage (Action)
  persistent (Entity)
    enabled (Property)
    clearLog (Action)

Entities​

log.v1

  • Description: Log root object
  • Type: Singleton
  • Operations: GET
  • Attributes: Dynamic Support: No

Version 1 of the Log object.

Properties

This entry has no properties

Actions

writeMessage

  • Description: Write log message to the system log
  • Request Datatype: WriteMessageRequest
  • Response Datatype: Empty Object
  • Trigger Permissions: admin
  • Attributes
    • Dynamic Support: No

log.v1.persistent

  • Description: Status of saving logs to the persistent storage
  • Type: Singleton
  • Operations: GET
  • Attributes: Dynamic Support: No

Properties

enabled

  • Description: Whether it is enabled to save logs to the persistent storage. enabled is a property in the log.v1.persistent entity that is able to switch the log saving to the persistent storage on and off.
  • Datatype: boolean
  • Operations:
    • GET - Permissions: admin, operator, viewer
    • SET - Permissions: admin
  • Attributes:
    • Nullable: No
    • Dynamic Support: No
    • Dynamic Enum: No
    • Dynamic Rang: No

Actions

clearLog

  • Description: Clear log file storing all logs. clearLog is an action in the log.v1.persistent entity. It is used to clear the log file on the persistent storage.
  • Request Datatype: Empty Object
  • Trigger Permissions: admin
  • Attributes
    • Dynamic Support: No

Data types​

LogMsg

  • Description: The message part of the log encoded in UTF-8
  • Type: string
  • Minimum Length: 0
  • Maximum Length: 4096
  • Pattern: ^.*$

LogSeverity

  • Description: Severity as defined by RFC5424
  • Type: integer
  • Minimum Value: 0
  • Maximum Value: 7

WriteMessageRequest

  • Description: The message to be logged, it contains the severity level of the message and the message itself.
  • Type: complex
  • Fields:
    • msg
      • Description: Text that provides information of the event
      • Type: LogMsg
      • Nullable: No
      • Gettable: No
    • severity
      • Description: Severity level of this message, default value is 6 meaning "Informational" level
      • Type: LogSeverity
      • Nullable: Yes
      • Gettable: No
Last updated on