Syslog

Read and download the system and application logs

The device keeps two log files: the system log (operating system and services) and the application log (IOTA services). Both can be read partially through the API or downloaded completely. Downloads are meant for a browser: the client first obtains a one-time download token with its session, then fetches the file with that token in the URL and without an authorization header.

API

• Get the system log
  • Path: /api/syslog/log/sys
  • Method: GET
  • Minimum user role: admin
  • URL parameters:
    • lines - optional, number of lines from the end of the log to return. Without it the last 300 MiB of the file are returned.
  • Response on success (200 OK): the log text as text/plain, with the header Content-Disposition: attachment; filename="syslog_<epoch>.txt"
  • Response on failure (400 Bad Request): lines is negative or not a number
• Get the application log
  • Path: /api/syslog/log/app
  • Method: GET
  • Minimum user role: admin
  • URL parameters: lines, as above
  • Response on success (200 OK): the log text as text/plain, with the header Content-Disposition: attachment; filename="applog_<epoch>.txt"
  • Response on failure (400 Bad Request): lines is negative or not a number
• Get a download token
  • Path: /api/syslog/token
  • Method: GET
  • Minimum user role: admin
  • Response on success (200 OK): the token as a plain-text body of 128 characters, no JSON envelope
  • Notes: a download token can be used once. It is bound to the session that requested it, so it stops working when that session logs out. The device keeps at most 100 unused tokens; the oldest is discarded when a new one is issued beyond that.
• Download the complete system log

  • Path: /api/syslog/system/download

  • Method: GET

  • Minimum user role: none (no authorization header); the download token in the URL is checked instead

  • URL parameters:

    • token - a download token from /api/syslog/token (mandatory)

  • Response on success (200 OK): the whole log file as text/plain, with the header Content-Disposition: attachment; filename="syslog_<epoch>.txt"

  • Response on failure (403 Forbidden): the token parameter is missing, unknown or already used

  • Example:

    TOKEN_DL=$(curl -sk -H "authorization: <token>" https://<ip-address>/api/syslog/token)
    curl -sk -o syslog.txt "https://<ip-address>/api/syslog/system/download?token=$TOKEN_DL"

• Download the complete application log
  • Path: /api/syslog/application/download
  • Method: GET
  • Minimum user role: none (no authorization header); the download token in the URL is checked instead
  • URL parameters: token, as above
  • Response on success (200 OK): the whole log file as text/plain, with the header Content-Disposition: attachment; filename="applog_<epoch>.txt"
  • Response on failure (403 Forbidden): the token parameter is missing, unknown or already used

Back to Index