Read Variable - Prefect

Overview
Settings reference
REST API
- REST API overview
- Cloud API
- Server API
  - Server API Overview
  - Root
  - Flows
  - Flow Runs
  - Task Runs
  - Flow Run States
  - Task Run States
  - Deployments
  - SavedSearches
  - Logs
  - Concurrency Limits
  - Concurrency Limits V2
  - Block types
  - Block documents
  - Work Pools
  - Task Workers
  - Work Queues
  - Artifacts
  - Block schemas
  - Block capabilities
  - Collections
  - Variables
    - POST
      Create Variable
    - GET
      Read Variable
    - DEL
      Delete Variable
    - PATCH
      Update Variable
    - GET
      Read Variable By Name
    - DEL
      Delete Variable By Name
    - PATCH
      Update Variable By Name
    - POST
      Read Variables
    - POST
      Count Variables
  - GET
    Create Csrf Token
  - Events
  - Automations
  - Admin
CLI Reference
Python SDK Reference

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

GET

api

variables

{id}

{
  "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

Path Parameters

string<uuid>

required

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

Path Parameters

Response