Read Block Schema By Id

Get a block schema by id.

Headers

x-prefect-api-version

string

Path Parameters

id

string

required

The block schema id

Response

200 - application/json

An ORM representation of a block schema.

checksum

string

required

The block schema's unique checksum

block_type_id

string | null

required

A block type ID

id

string

created

string | null

updated

string | null

fields

object

The block schema's field schema

block_type

object | null

The associated block type

Show child attributes

block_type.name

string

required

A block type's name

block_type.slug

string

required

A block type's slug

block_type.id

string

block_type.created

string | null

block_type.updated

string | null

block_type.logo_url

string | null

Web URL for the block type's logo

block_type.documentation_url

string | null

Web URL for the block type's documentation

block_type.description

string | null

A short blurb about the corresponding block's intended use

block_type.code_example

string | null

A code snippet demonstrating use of the corresponding block

block_type.is_protected

boolean

default: false

Protected block types cannot be modified via API.

capabilities

string[]

A list of Block capabilities

version

string

default: non-versioned

Human readable identifier for the block schema