Read Block Schemas

Read all block schemas, optionally filtered by type

Headers

x-prefect-api-version

string

Body

application/json

block_schemas

object | null

Filter BlockSchemas

Show child attributes

block_schemas.block_capabilities

object | null

Filter criteria for BlockSchema.capabilities

Show child attributes

block_schemas.block_capabilities.all_

string[] | null

A list of block capabilities. Block entities will be returned only if an associated block schema has a superset of the defined capabilities.

block_schemas.block_type_id

object | null

Filter criteria for BlockSchema.block_type_id

Show child attributes

block_schemas.block_type_id.any_

string[] | null

A list of block type ids to include

block_schemas.id

object | null

Filter criteria for BlockSchema.id

Show child attributes

block_schemas.id.any_

string[] | null

A list of IDs to include

block_schemas.operator

enum<string>

Operator for combining filter criteria. Defaults to 'and_'.

Available options:

and_,

or_

block_schemas.version

object | null

Filter criteria for BlockSchema.version

Show child attributes

block_schemas.version.any_

string[] | null

A list of block schema versions.

limit

integer

Defaults to PREFECT_API_DEFAULT_LIMIT if not provided.

offset

integer

default:

0

Required range: x > 0

Response

200 - application/json

block_type_id

string | null

required

A block type ID

checksum

string

required

The block schema's unique checksum

created

string | null

required

id

string

required

updated

string | null

required

block_type

object | null

The associated block type

Show child attributes

block_type.created

string | null

required

block_type.id

string

required

block_type.name

string

required

A block type's name

block_type.slug

string

required

A block type's slug

block_type.updated

string | null

required

block_type.code_example

string | null

A code snippet demonstrating use of the corresponding block

block_type.description

string | null

A short blurb about the corresponding block's intended use

block_type.documentation_url

string | null

Web URL for the block type's documentation

block_type.is_protected

boolean

default:

false

Protected block types cannot be modified via API.

block_type.logo_url

string | null

Web URL for the block type's logo

capabilities

string[]

A list of Block capabilities

fields

object

The block schema's field schema

version

string

default:

non-versioned

Human readable identifier for the block schema