v1

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

Block schemas

Read Block Schemas

Read all block schemas, optionally filtered by type

post/api/block_schemas/filter

Headers

x-prefect-api-versionstring

Request body

offsetinteger

limitinteger

Defaults to PREFECT_API_DEFAULT_LIMIT if not provided.

Example request

{
  "block_schemas": {
    "block_capabilities": {
      "all_": [
        "write-storage",
        "read-storage"
      ]
    },
    "version": {
      "any_": [
        "2.0.0",
        "2.1.0"
      ]
    }
  }
}

Response

Successful Response

idstring uuid

createdstring date-time

updatedstring date-time

checksumstring required

The block schema's unique checksum

fieldsobject

The block schema's field schema

block_type_idstring uuid required

A block type ID

capabilitiesstring[]

A list of Block capabilities

versionstring

Human readable identifier for the block schema