FOformancehq
Logs

Get a single system log by bucket-wide sequence

Changed on

Returns the system log entry with the given bucket-wide sequence number. Requires ledger:ReadOps scope.

get/v3/_/logs/{sequence}

Request

  • Base URL
    http://localhost:9000
  • URL
    http://localhost:9000/v3/_/logs/{sequence}
  • Auth
    • HTTP bearer
    • or none

Path parameters

sequenceinteger required

Headers

X-Consistency'linearizable' | 'stale'

Read consistency. linearizable (the default) runs a Raft ReadIndex barrier and waits for the receiving node to apply up to it. stale serves the read from the receiving node's own store, with no barrier and no forwarding to the leader, so the answer may lag the leader. Matching ignores case and surrounding whitespace. An unknown value, or a repeated or comma-joined header, returns 400 INVALID_REQUEST on every /v3 route, writes included; a valid value has no effect on writes. The gRPC equivalent is the x-consistency request metadata.

Formance-Bigint-As-Stringstring

Render all response Uint256, BigUint and SignedBigInt values as canonical decimal strings, regardless of business meaning, including posting amounts, volume input/output and balances. Ordinary integer IDs/counts, metadata and explicitly string-encoded counters keep their existing representation. Case-insensitive true, yes, y and 1 enable this option, matching Ledger v2. Whitespace is not trimmed. Omission and every other value retain JSON number tokens. This affects only this response, including nested objects, maps, arrays, transaction/log/cursor and bulk results. Request decoding is unchanged.

Response

Log retrieved successfully.

Example response

{
  "data": {
    "payload": {
      "apply": {
        "log": {
          "type": "SET_METADATA",
          "data": {
            "targetType": "ACCOUNT",
            "targetId": "users:alice",
            "metadata": {
              "category": "premium"
            }
          }
        }
      }
    }
  }
}

Changes