Get log entries for a systemd unit

GET 
/node/:hostname/log/unit/:name

Retrieve log entries for a specific systemd unit on the target node.

Request

Path Parameters

hostname stringrequired

Possible values: non-empty

Target agent hostname, reserved routing value (_any, _all), or label selector (key:value).

name stringrequired

Possible values: non-empty

Systemd unit name (e.g., "nginx.service", "sshd.service").

Query Parameters

lines integer

Possible values: >= 1 and <= 10000

Default value: 100

Maximum number of log lines to return.

since string

Return log entries since this time. Accepts systemd time specifications (e.g., "1h", "2026-01-01 00:00:00").

priority string

Filter by log priority level (e.g., "err", "warning", "info", "debug").

Responses

200

Log entries for the specified unit.

application/json

Schema

Schema

job_id uuid

The job ID used to process this request.

results

object[]

required

Array [

hostname stringrequired

The hostname of the agent.

status stringrequired

Possible values: [ok, failed, skipped]

The status of the operation for this host.

entries

object[]

Log entries from this agent.

Array [

timestamp string

Log entry timestamp.

unit string

Systemd unit that produced this entry.

priority string

Log priority level.

message string

Log message text.

pid integer

Process identifier that produced this entry.

hostname string

Hostname of the system that produced this entry.

]

error string

Error message if the agent failed.

]

Example (from schema)

{
  "job_id": "550e8400-e29b-41d4-a716-446655440000",
  "results": [
    {
      "hostname": "string",
      "status": "ok",
      "entries": [
        {
          "timestamp": "2026-01-15T10:30:00Z",
          "unit": "nginx.service",
          "priority": "info",
          "message": "Server started successfully",
          "pid": 1234,
          "hostname": "web-01"
        }
      ],
      "error": "string"
    }
  ]
}

400

Bad request - validation error.

application/json

Schema

Schema

error string

A description of the error that occurred.

details string

Additional details about the error.

code integer

The error code.

Example (from schema)

{
  "error": "Failed to retrieve status.",
  "details": "Failed due to network timeout.",
  "code": 500
}

401

Unauthorized - API key required

application/json

Schema

Schema

error string

A description of the error that occurred.

details string

Additional details about the error.

code integer

The error code.

Example (from schema)

{
  "error": "Failed to retrieve status.",
  "details": "Failed due to network timeout.",
  "code": 500
}

403

Forbidden - Insufficient permissions

application/json

Schema

Schema

error string

A description of the error that occurred.

details string

Additional details about the error.

code integer

The error code.

Example (from schema)

{
  "error": "Failed to retrieve status.",
  "details": "Failed due to network timeout.",
  "code": 500
}

500

Error retrieving unit log entries.

application/json

Schema

Schema

error string

A description of the error that occurred.

details string

Additional details about the error.

code integer

The error code.

Example (from schema)

{
  "error": "Failed to retrieve status.",
  "details": "Failed due to network timeout.",
  "code": 500
}

Loading...