List a system's members' recent log lines

GET

/systems/{name}/logs

const url = 'https://example.com/api/v1/systems/example/logs';
const options = {method: 'GET'};

try {
  const response = await fetch(url, options);
  const data = await response.json();
  console.log(data);
} catch (error) {
  console.error(error);
}

curl --request GET \
  --url https://example.com/api/v1/systems/example/logs

Returns the members’ raw log lines merged newest first, bounded to the last 24 hours and capped, each naming the component that wrote it. Gated by system:read; an out-of-scope system is a non-disclosing 404.

Parameters

Path Parameters

name

required

The system’s name, or a dotted address (e.g. boi.17c.$sys.av)

string

The system’s name, or a dotted address (e.g. boi.17c.$sys.av)

Responses

200

application/json

object

$schema

A URL to the JSON Schema for this object.

string format: uri

logs

required

Array<object> | null

object

attributes

Structured fields parsed from the line, when present

component

required

The member component that wrote the line

string

correlation_id

Threads related lines and their derived events

string

facility

The line’s facility, when classified

string

instance

The series discriminator, when set

string

labels

Freeform classification labels, when present

message

required

The raw log text

string

severity

The line’s severity, when classified

string

source

The channel the line arrived on (e.g. syslog)

string

required

When the line arrived

string format: date-time

system

required

string

Example

{
  "$schema": "/api/v1/schemas/SystemLogsOutputBody.json"
}

default

Error

application/problem+json

object

$schema

A URL to the JSON Schema for this object.

string format: uri

detail

A human-readable explanation specific to this occurrence of the problem.

string

errors

Optional list of individual error details

Array<object> | null

object

location

Where the error occurred, e.g. ‘body.items[3].tags’ or ‘path.thing-id’

string

message

Error message text

string

value

The value at the given location

instance

A URI reference that identifies the specific occurrence of the problem.

string format: uri

status

HTTP status code

integer format: int64

title

A short, human-readable summary of the problem type. This value should not change between occurrences of the error.

string

type

A URI reference to human-readable documentation for the error.

string format: uri

default: about:blank

Example

{
  "$schema": "/api/v1/schemas/ErrorModel.json",
  "detail": "Property foo is required but is missing.",
  "instance": "https://example.com/error-log/abc123",
  "status": 400,
  "title": "Bad Request",
  "type": "about:blank"
}