v1

latestOpenAPI 3.1.0raw.githubusercontent.com2024-11-08170291390.5 KB

Variables

Read Variables

post/api/variables/filter

Headers

x-prefect-api-versionstring

Request body

offsetinteger

sort'CREATED_DESC' | 'UPDATED_DESC' | 'NAME_DESC' | 'NAME_ASC'

Defines variables sorting options.

limitinteger

Defaults to PREFECT_API_DEFAULT_LIMIT if not provided.

Example request

{
  "variables": {
    "name": {
      "like_": "my_variable_%"
    },
    "value": {
      "like_": "my-value-%"
    },
    "tags": {
      "all_": [
        "tag-1",
        "tag-2"
      ]
    }
  }
}

Response

Successful Response

idstring uuid

createdstring date-time

updatedstring date-time

namestring required

The name of the variable

valuestring required

The value of the variable

tagsstring[]

A list of variable tags

Example response

[
  {
    "name": "my-variable",
    "value": "my-value",
    "tags": [
      "tag-1",
      "tag-2"
    ]
  }
]