Sign in

v1

latestOpenAPI 3.1.02026-07-26101317.6 KB
Logs

List Log Files

Returns available log files for an endpoint. Supports filtering by replica and history.

get/endpoints/{endpoint_id}/logs

Path parameters

endpoint_idstring required

Unique endpoint ID.

Query parameters

replica_idstring

Filter logs by a specific replica ID.

include_historyboolean

Set to false to exclude rotated historical logs and return only current active logs.

Response

List of log files.

node_idstring

Node ID where the log is stored.

replica_idstring

Associated replica ID.

filenamestring

Log file path. Use as the filename parameter in the /logs/file API.

is_historicalboolean

Whether this is a rotated historical log file from a terminated replica.

start_timestring date-time nullable

Log start time. Only available for historical logs.

end_timestring date-time nullable

Log end time. Only available for historical logs.