Skip to main content
GET
/
api
/
svc
/
v1
/
logs
/
{workspaceId}
/
download
Download workspace logs
curl --request GET \
  --url https://{controlPlaneURL}/api/svc/v1/logs/{workspaceId}/download \
  --header 'Authorization: Bearer <token>'
"<string>"

Authorizations

​
Authorization
string
header
required

Bearer authentication header of the form Bearer <token>, where <token> is your auth token.

Path Parameters

​
workspaceId
string
required

Query Parameters

​
startTs
string | null

Start timestamp for querying logs, in nanoseconds from the Unix epoch.

Example:

"1635467890123456789"

​
endTs
string | null

End timestamp for querying logs, in nanoseconds from the Unix epoch.

Example:

"1635467891123456789"

​
limit
string | null

Max number of log lines to fetch

​
direction
string | null

Direction of sorting logs. Can be asc or desc

​
getLogsQuery
GetLogsQuery · object

Query params to fetch logs

​
filterQuery
LogsFilterQuery · object

Query to filter logs

​
numLogsToIgnore
number | null

Number of logs corresponding to the starting timestamp to be ignored.

Response

Streamed plain-text log file.

The response is of type file.