Get harness logs

Get logs for a harness

Required permission

Project > Harnesses > General > Read

Path parameters

Query parameters

deploymentId
string
Limit logs to a specific deployment.
type
string
Type of log. Multiple log types can be selected by specifying the query parameter repeatedly.
one of
cdn, mesh, ingress, runtime, build, backup, restore
containerName
(multiple options: anyOf)
Limits logs to specific container(s). Multiple containers can be selected by specifying the query parameter repeatedly.

[array] required

string required

min length

max length

queryType
string
`range` selects a log range and returns immediately.
one of
range
startTime
string
Fetch logs generated after this timestamp.
endTime
string
Fetch logs generated before this timestamp.
duration
integer
Range duration in seconds. If set, only one of `startTime` or `endTime` can be set.
lineLimit
integer
Number of log lines to fetch.
min
0
max
1000
direction
string
Ordering of log lines
one of
backward, forward
textIncludes
string
Filter log lines to match this search string
min length
1
max length
100
textNotIncludes
string
Filter log lines to not match this search string
min length
1
max length
100
regexIncludes
string
Filter log lines to match this regular expression
min length
1
max length
100
regexNotIncludes
string
Filter log lines to not match this regular expression
min length
1
max length
100

Response body

GET /v1/projects/{projectId}/harnesses/{harnessId}/logs

GET /v1/teams/{teamId}/projects/{projectId}/harnesses/{harnessId}/logs

Example response

200 OK

List of logs values

JSON

{
  "data": [
    {
      "log": "stdout F This is a log line",
      "ts": "2023-03-21T15:01:17.310Z"
    }
  ]
}