Logs | Nodeum Docs

List all logs

get

API Key Scope: logs / index

Authorizations

AuthorizationstringRequired

Pass the username and password of a user in the authorization header. This currently gives full access.

Query parameters

limitintegerOptional

The number of items to display for pagination.

offsetintegerOptional

The number of items to skip for pagination.

levelstringOptional

Filter on task log level

timestringOptional

Filter on time

msgstringOptional

Filter on message

hostnamestringOptional

Filter on task log hostname

tagstringOptional

Filter on task log tag

Responses

200

List of logs.

application/json

get

/logs

GET /api/v2/logs HTTP/1.1
Host: localhost
Authorization: Basic username:password
Accept: */*

200

List of logs.

{
  "count": 1,
  "logs": [
    {
      "id": "text",
      "level": "trace",
      "msg": "text",
      "time": "2025-12-21T14:37:25.374Z",
      "hostname": "text",
      "tag": "nodeum.dispatcher",
      "error": "text",
      "stacktrace": "text"
    }
  ]
}

Displays the logs configuration.

get

API Key Scope: configs / show

Authorizations

AuthorizationstringRequired

Pass the username and password of a user in the authorization header. This currently gives full access.

Responses

200

OK

application/json

Responseany

default

Error returned from the data management.

application/json

get

/logs/config

GET /api/v2/logs/config HTTP/1.1
Host: localhost
Authorization: Basic username:password
Accept: */*

No content

Updates the existing logs configuration.

put

API Key Scope: configs / update

Authorizations

AuthorizationstringRequired

Pass the username and password of a user in the authorization header. This currently gives full access.

Body

anyOptional

Responses

200

OK

application/json

Responseany

422

The received resource was not correctly formatted.

application/json

default

Error returned from the data management.

application/json

put

/logs/config

PUT /api/v2/logs/config HTTP/1.1
Host: localhost
Authorization: Basic username:password
Content-Type: application/json
Accept: */*

No content

Clear all notifications

post

API Key Scope: logs / post

Authorizations

AuthorizationstringRequired

Pass the username and password of a user in the authorization header. This currently gives full access.

Responses

204

Log notifications clear

post

/logs/clear_notifications

POST /api/v2/logs/clear_notifications HTTP/1.1
Host: localhost
Authorization: Basic username:password
Accept: */*

204

Log notifications clear

No content