HomepageBlog

Logs

List all logs

get

API Key Scope: logs / index

Authorizations
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-11-05T15:48:07.595Z",
      "hostname": "text",
      "tag": "nodeum.dispatcher",
      "error": "text",
      "stacktrace": "text"
    }
  ]
}

Displays the logs configuration.

get

API Key Scope: configs / show

Authorizations
Responses
200

OK

application/json
Responseany
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
Body
anyOptional
Responses
200

OK

application/json
Responseany
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
Responses
204

Log notifications clear

No content
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

Last updated

Was this helpful?