Skip to main content
GET
/
api
/
svc
/
v1
/
logs
Get Logs
curl --request GET \
  --url https://{controlPlaneURL}/api/svc/v1/logs \
  --header 'Authorization: Bearer <token>'
{
  "data": [
    {
      "job_name": "<string>",
      "log": "<string>",
      "stream": "<string>",
      "time": "<string>",
      "containerName": "<string>"
    }
  ]
}

Authorizations

​
Authorization
string
header
required

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

Query Parameters

​
startTs
integer

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

​
endTs
integer

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

​
limit
integer

Max number of log lines to fetch

​
direction
enum<string>

Direction of sorting logs. Can be asc or desc

Available options:
asc,
desc
​
numLogsToIgnore
integer

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

​
applicationId
string

Application ID

​
applicationFqn
string

Application FQN

​
deploymentId
string

Deployment ID

​
jobRunName
string

Name of the Job Run for which to fetch logs.

​
podName
string

Name of Pod for which to fetch logs.

​
containerName
string

Name of the Container for which to fetch logs.

​
podNames
string[]

List of pod names for which to fetch logs.

​
podNamesRegex
string

Regex pattern for pod names to fetch logs.

​
searchFilters
string

JSON string containing array of search filters with string, type and operator

​
searchString
string

String that needs to be matched

​
searchType
enum<string>

Query filter type, regex substring ignore_case_substring

Available options:
regex,
substring,
ignore_case_substring
​
searchOperator
enum<string>

Comparison operator for filter. equal or not_equal

Available options:
equal,
not_equal

Response

Successfully retrieved logs for the workload

​
data
Log · object[]
required

List of logs

⌘I