POST
/
api
/
variables
/
filter
[
  {
    "id": "3c90c3cc-0d44-4b50-8888-8dd25736052a",
    "created": "2023-11-07T05:31:56Z",
    "updated": "2023-11-07T05:31:56Z",
    "name": "my-variable",
    "value": "my-value",
    "tags": [
      "tag-1",
      "tag-2"
    ]
  }
]

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

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
value
required

The value of the variable

tags
string[]

A list of variable tags