Read Logs - Prefect

Headers

x-prefect-api-version

string

Body

application/json

offset

integer

default:0

Required range: x >= 0

logs

LogFilter · object

Filter logs. Only logs matching all criteria will be returned

Show child attributes

logs.operator

enum<string>

default:and_

Operator for combining filter criteria. Defaults to 'and_'.

Available options:

and_,

or_

logs.level

LogFilterLevel · object

Filter criteria for Log.level

Show child attributes

logs.level.ge_

integer | null

Include logs with a level greater than or equal to this level

Example:

20

logs.level.le_

integer | null

Include logs with a level less than or equal to this level

Example:

50

logs.timestamp

LogFilterTimestamp · object

Filter criteria for Log.timestamp

Show child attributes

logs.timestamp.before_

string<date-time> | null

Only include logs with a timestamp at or before this time

logs.timestamp.after_

string<date-time> | null

Only include logs with a timestamp at or after this time

logs.flow_run_id

LogFilterFlowRunId · object

Filter criteria for Log.flow_run_id

Show child attributes

logs.flow_run_id.any_

string<uuid>[] | null

A list of flow run IDs to include

logs.task_run_id

LogFilterTaskRunId · object

Filter criteria for Log.task_run_id

Show child attributes

logs.task_run_id.any_

string<uuid>[] | null

A list of task run IDs to include

logs.task_run_id.is_null_

boolean | null

If true, only include logs without a task run id

logs.text

LogFilterTextSearch · object

Filter criteria for text search across log content

Show child attributes

logs.text.query

string

required

Text search query string

Maximum string length: 200

sort

enum<string>

default:TIMESTAMP_ASC

Defines log sorting options.

Available options:

TIMESTAMP_ASC,

TIMESTAMP_DESC

limit

integer

Defaults to PREFECT_API_DEFAULT_LIMIT if not provided.

Response

Successful Response

string<uuid>

required

created

string<date-time> | null

required

updated

string<date-time> | null

required

name

string

required

The logger name.

level

integer

required

The log level.

message

string

required

The log message.

timestamp

string<date-time>

required

The log timestamp.

flow_run_id

string<uuid> | null

The flow run ID associated with the log.

task_run_id

string<uuid> | null

The task run ID associated with the log.

API Reference

Headers

Body

Response