Logs

Reset the device logs and forward them to remote syslog servers

API

• Data (REMOTE_LOGGING_SERVER object):

  {
      "id": 1,
      "hostname": "syslog.example.com",
      "port": 514,
      "protocol": "udp",
      "priority": "info",
      "active": true,
      "facility": "system"
  }

  • id - unsigned integer assigned by the device (read-only)
  • hostname - hostname, IPv4 or IPv6 address of the syslog server (mandatory)
  • port - 1 to 65535 (mandatory)
  • protocol - udp or tcp
  • priority - minimum priority of the messages to forward: emerg, alert, crit, error, warning, notice, info or debug
  • active - true if forwarding to this server is enabled
  • facility - which logs are forwarded: system, application or both

  A missing or invalid field is rejected with 400 and a message of the form The validation has failed: The validation has failed on <field>. Constraint: <name> (<text>). Path: /.

• Reset the system log:

  • Path: /api/system/log/sys
  • Method: DELETE
  • Minimum user role: admin
  • Response on success (200 OK): message Succesfully reset sys logs

• Reset the application log:

  • Path: /api/system/log/app
  • Method: DELETE
  • Minimum user role: admin
  • Response on success (200 OK): message Succesfully reset app logs

• List remote logging servers:

  • Path: /api/system/log/servers
  • Method: GET
  • Minimum user role: admin
  • Response on success (200 OK): array of REMOTE_LOGGING_SERVER objects in data

• Get a remote logging server:

  • Path: /api/system/log/servers/{ID}
  • Method: GET
  • Minimum user role: admin
  • Response on success (200 OK): REMOTE_LOGGING_SERVER object in data
  • Response on failure (404 Not Found): {"message": "syslog_server with id <ID> not found!", "data": {"status_code": 404}}

• Add a remote logging server:

  • Path: /api/system/log/servers
  • Method: POST
  • Minimum user role: admin
  • Request body: REMOTE_LOGGING_SERVER object without id; all fields except id must be given
  • Response on success (200 OK): the created object in data
  • Response on failure (400 Bad Request): validation message as described above

• Edit a remote logging server:

  • Path: /api/system/log/servers/{ID}
  • Method: PUT
  • Minimum user role: admin
  • Request body: REMOTE_LOGGING_SERVER object; fields that are omitted keep their current value
  • Response on success (200 OK): the updated object in data

• Delete a remote logging server:

  • Path: /api/system/log/servers/{ID}
  • Method: DELETE
  • Minimum user role: admin
  • Response on success (200 OK): the deleted object in data
  • Response on failure (404 Not Found): {"message": "Id <ID> not found!", "data": {"status_code": 404}}

Back to System