Skip to main content
POST
/
api
/
variables
/
filter
Read Variables
curl --request POST \
  --url https://api.example.com/api/variables/filter \
  --header 'Content-Type: application/json' \
  --data '
{
  "offset": 0,
  "variables": {
    "operator": "and_",
    "id": {
      "any_": [
        "3c90c3cc-0d44-4b50-8888-8dd25736052a"
      ]
    },
    "name": {
      "any_": [
        "<string>"
      ],
      "like_": "my_variable_%"
    },
    "tags": {
      "operator": "and_",
      "all_": [
        "tag-1",
        "tag-2"
      ],
      "is_null_": true
    }
  },
  "sort": "NAME_ASC",
  "limit": 123
}
'
[
  {
    "id": "3c90c3cc-0d44-4b50-8888-8dd25736052a",
    "created": "2023-11-07T05:31:56Z",
    "updated": "2023-11-07T05:31:56Z",
    "name": "<string>",
    "value": "my-value",
    "tags": [
      "<string>"
    ]
  }
]

Headers

​
x-prefect-api-version
string

Body

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

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:
["tag-1", "tag-2"]