Get log file content

GET

/system/logs/{file}

curl --request GET \
  --url 'https://example.com/api/v1/system/logs/example?n=10&skip=0' \
  --cookie grommunioAuthJwt=<grommunioAuthJwt>

• Default deployment path

Returns the n last lines of the log file, similar to the tail command line tool

Authorizations

• JWTCookie

Parameters

Path Parameters

file

required

string

Name of the log file

Query Parameters

n

integer

default: 10 >= 1

Number of lines to return

skip

integer

0

Number of lines to skip

after

Precise date/time string including fractional seconds

string

/^\d{4}-\d{2}-\d{2} \d{2}:\d{2}:\d{2}\.\d{1,6}$/

Return all lines after given time. Overrides n and skip.

Responses

200

List of log files returned

Media typeapplication/json

object

data

Array<object>

Log file entry

object

level

Priority level number as described in journalctl (1)

integer

message

Log message

string

time

Precise date/time string including fractional seconds

string

/^\d{4}-\d{2}-\d{2} \d{2}:\d{2}:\d{2}\.\d{1,6}$/

runtime

Time since last reboot

number

Example^generated

{
  "data": [
    {
      "level": 1,
      "message": "example",
      "time": "example",
      "runtime": 1
    }
  ]
}

400

Validation of input parameters failed

Media typeapplication/json

object

message

string

errors

List of errors encountered during validation

Array<string>

Example^generated

{
  "message": "example",
  "errors": [
    "example"
  ]
}

404

The requested resource could not be found

Media typeapplication/json

object

message

string

Example^generated

{
  "message": "example"
}

500

An error occurred while processing the request

Media typeapplication/json

object

message

String representation of the exception

string

Example^generated

{
  "message": "example"
}