Skip to main content
POST
Read Variables

Headers

x-prefect-api-version
string

Body

application/json
offset
integer
default:0
Required range: x >= 0
variables
VariableFilter · object | null

Filter variables. Only variables matching all criteria will be returned

sort
enum<string>
default:NAME_ASC

Defines variables sorting options.

Available options:
CREATED_DESC,
UPDATED_DESC,
NAME_DESC,
NAME_ASC
limit
integer

Defaults to PREFECT_API_DEFAULT_LIMIT if not provided.

Response

Successful Response

id
string<uuid>
required
created
string<date-time> | null
required
updated
string<date-time> | null
required
name
string
required

The name of the variable

Maximum string length: 255
Example:

"my-variable"

value
required

The value of the variable

Example:

"my-value"

tags
string[]

A list of variable tags

Example: