Sign in

Scan entries

Scan log entries for a given key within an optional sequence range.

Supports long-polling: set follow=true to hold the connection open until new data arrives or timeout_ms elapses (default 30 000 ms). This is useful for tailing a log stream in near-real-time.

get/api/v1/log/scan

Query parameters

keystring required

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

start_seqinteger

Start sequence number (inclusive). Defaults to 0.

end_seqinteger

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

limitinteger

Maximum number of entries to return.

followboolean

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

timeout_msinteger

Timeout in milliseconds for long-polling. Default 30000.

Response

Scan results.

statusstring required
keystring byte

The key that was scanned, base64-encoded.

Example response

{
  "status": "success"
}

Changes

Changed in 1 of the 2 revisions of this API.2

  • 792e23c433012See the full diff
    • ▲

      the key response's property type/format changed from object/ to string/byte for status 200

      response-property-type-changed

    • ▲

      removed the required property key/value from the response with the 200 status

      response-required-property-removed