Skip to main content
GET
Read Block Schema By Checksum

Headers

x-prefect-api-version
string

Path Parameters

checksum
string
required

The block schema checksum

Query Parameters

version
string | null

Version of block schema. If not provided the most recently created block schema with the matching checksum will be returned.

Response

Successful Response

An ORM representation of a block schema.

id
string<uuid>
required
created
string<date-time> | null
required
updated
string<date-time> | null
required
checksum
string
required

The block schema's unique checksum

block_type_id
string<uuid> | null
required

A block type ID

fields
Fields · object

The block schema's field schema

block_type
BlockType · object | null

The associated block type

capabilities
string[]

A list of Block capabilities

version
string
default:non-versioned

Human readable identifier for the block schema