Read Variables - Prefect

[
  {
    "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"
    ]
  }
]

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

Show child attributes

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

Successful Response

string<uuid>

required

created

string<date-time> | null

required

updated

string<date-time> | null

required

name

string

required

The name of the variable

Maximum length: 255

Examples:

"my-variable"

value

required

The value of the variable

Examples:

"my-value"

API Reference

Headers

Body

Response