List segments

List log segments whose start sequence falls within the given range. Segments are the physical storage units of the log.

GET /api/v1/log/segments

List segments

cURL

curl --request GET \
  --url http://localhost:3001/api/v1/log/segments

200

{
  "status": "success",
  "segments": [
    {
      "id": 0,
      "startSeq": 0,
      "startTimeMs": 1705766400000
    }
  ]
}

Query Parameters

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

Response

200

application/json

List of segments.

Response listing log segments.

status · string · required

Example:

"success"

segments · object[] · required

Show child attributes