Skip to content

The engine log's ring-buffer snapshot, newest last, with the match total and whether older matches were left out

GET
/v1/console/logs/buffer
curl --request GET \
--url 'https://example.com/v1/console/logs/buffer?limit=1000' \
--header 'Authorization: Bearer <token>'

Returns the engine log’s ring-buffer snapshot, newest last, filtered by module and level. total is the number of ring entries that matched the filter (not the page size) and truncated says older matches were left out.

module
string

Only entries from this module.

levels
string

Exact level set, comma-separated (debug, info, warn, error); authoritative whenever non-empty. An empty value clears the level filter; an unknown level is a 400, never a silent widening.

level
string

Legacy minimum-level threshold, used only when levels is empty or absent.

limit
integer
default: 1000

How many entries to return (default 1000, at most 10000: a larger value is clamped, a missing or non-positive one uses the default).

OK

Media type application/json
object
capture_level
required

The level the engine currently captures at.

string
items
required
Array<object>

One engine log entry, newest last.

object
returned
required

Entries this response carries.

integer
total
required

Entries in the ring that matched the filter — the size of the set, not of this page.

integer
truncated
required

Older matches were left out.

boolean
Example generated
{
"capture_level": "example",
"items": [
{}
],
"returned": 1,
"total": 1,
"truncated": true
}

Bad request

Media type application/json
object
error
required
object
code
required
string
message
required
string
module

With code module_not_enabled: the namespace of the module this node does not run.

string
Example generated
{
"error": {
"code": "example",
"message": "example",
"module": "example"
}
}

Unauthenticated

Media type application/json
object
error
required
object
code
required
string
message
required
string
module

With code module_not_enabled: the namespace of the module this node does not run.

string
Example generated
{
"error": {
"code": "example",
"message": "example",
"module": "example"
}
}

Forbidden

Media type application/json
object
error
required
object
code
required
string
message
required
string
module

With code module_not_enabled: the namespace of the module this node does not run.

string
Example generated
{
"error": {
"code": "example",
"message": "example",
"module": "example"
}
}

Not found

Media type application/json
object
error
required
object
code
required
string
message
required
string
module

With code module_not_enabled: the namespace of the module this node does not run.

string
Example generated
{
"error": {
"code": "example",
"message": "example",
"module": "example"
}
}

Conflict / setup required

Media type application/json
object
error
required
object
code
required
string
message
required
string
module

With code module_not_enabled: the namespace of the module this node does not run.

string
Example generated
{
"error": {
"code": "example",
"message": "example",
"module": "example"
}
}

Rate limited

Media type application/json
object
error
required
object
code
required
string
message
required
string
module

With code module_not_enabled: the namespace of the module this node does not run.

string
Example generated
{
"error": {
"code": "example",
"message": "example",
"module": "example"
}
}