Retrieves Logs

get

https://{serverURL}/api/logs

Retrieves logs based on filters provided.

Recent Requests

Time	Status	User Agent
Retrieving recent requests…

Loading…

Query Params

max

int64

Defaults to 25

Maximum number of records to return

offset

int64

Defaults to 0

Offset records, the number of records to skip, for paginating requests

sort

string

Defaults to name

Sort order, the name of the property to sort by

order

string

enum

Defaults to asc

Sort direction, use 'desc' to reverse sort

Allowed:

query

string

Alias for phrase

message

string

Filter by message

sourceType

string

Filter by source type

typeCode

string

Filter by code type

objectId

int64

Filter by objectId

token

string

Filter by token

level

string

enum

Filter by log level. Multiple values can be passed pipe delimited.

Allowed:

startMs

int64

Date filter in milliseconds (unix epoch), restricts query to only load logs updated more recently than the time specified.

endMs

int64

Date filter in milliseconds (unix epoch), restricts query to only load logs updated before the time specified.

startDateTime

date-time

Start Date timestamp (ISO 8601)

endDateTime

date-time

End Date timestamp (ISO 8601)

containers

int64

The Container ID(s) for filtering. Accepts multiple values.

servers

int64

The Server ID(s) for filtering. Accepts multiple values.

clusterId

int64

The Cluster ID(s) for filtering. Accepts multiple values.

Responses

Language

Credentials

Bearer

URL

Loading…

Response

Click Try It! to start a request and see the response here! Or choose an example:

application/json

200Successful Request

4XXError Codes

5XXError Codes