Skip to main content
GET
/
api
/
v1
/
log
/
scan
Scan entries
curl --request GET \
  --url http://localhost:3001/api/v1/log/scan
{
  "status": "success",
  "key": "dGVzdC1rZXk=",
  "values": [
    {
      "sequence": 42,
      "value": "dGVzdC12YWx1ZQ=="
    }
  ]
}

Query Parameters

​
key
string
required

Key to scan (URL-encoded if it contains special characters).

​
start_seq
integer<uint64>

Start sequence number (inclusive). Defaults to 0.

Required range: x >= 0
​
end_seq
integer<uint64>

End sequence number (exclusive). Defaults to max uint64.

Required range: x >= 0
​
limit
integer

Maximum number of entries to return.

Required range: x >= 0
​
follow
boolean

If true, long-poll until data is available or timeout.

​
timeout_ms
integer<uint64>

Timeout in milliseconds for long-polling. Default 30000.

Required range: x >= 0

Response

Scan results.

Response containing scanned log entries for a key.

​
status
string
required
Example:

"success"

​
values
object[]
required

Matching log entries.

​
key
string<byte>

The key that was scanned, base64-encoded.