Read Variables

Headers

x-prefect-api-version

string

Body

application/json

offset

integer

default:0

Required range: x >= 0

variables

object | null

Filter variables. Only variables matching all criteria will be returned

Show child attributes

variables.operator

enum<string>

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

Available options:

and_,

or_

variables.id

object | null

Filter criteria for Variable.id

Show child attributes

variables.id.any_

string[] | null

A list of variable ids to include

variables.name

object | null

Filter criteria for Variable.name

Show child attributes

variables.name.any_

string[] | null

A list of variables names to include

variables.name.like_

string | null

A string to match variable names against. This can include SQL wildcard characters like % and _.

Example:

"my_variable_%"

variables.tags

object | null

Filter criteria for Variable.tags

Show child attributes

variables.tags.operator

enum<string>

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

Available options:

and_,

or_

variables.tags.all_

string[] | null

A list of tags. Variables will be returned only if their tags are a superset of the list

Example:

["tag-1", "tag-2"]

variables.tags.is_null_

boolean | null

If true, only include Variables without tags

sort

enum<string>

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

200

application/json

Successful Response

id

string

required

created

string | null

required

updated

string | null

required

name

string

required

The name of the variable

Maximum length: 255

Example:

"my-variable"

value

required

The value of the variable

Example:

"my-value"

tags

string[]

A list of variable tags

Example:

["tag-1", "tag-2"]