Read Block Document By Name For Block Type

Headers

x-prefect-api-version

string

Path Parameters

slug

string

required

The block type name

block_document_name

string

required

The block type name

Query Parameters

include_secrets

boolean

default:

false

Whether to include sensitive values in the block document.

Response

200 - application/json

An ORM representation of a block document.

block_schema_id

string

required

A block schema ID

block_type_id

string

required

A block type ID

created

string | null

required

id

string

required

updated

string | null

required

block_document_references

object

Record of the block document's references

Show child attributes

block_document_references.{key}

object

block_schema

object | null

The associated block schema

Show child attributes

block_schema.block_type_id

string | null

required

A block type ID

block_schema.checksum

string

required

The block schema's unique checksum

block_schema.created

string | null

required

block_schema.id

string

required

block_schema.updated

string | null

required

block_schema.block_type

object | null

The associated block type

Show child attributes

block_schema.block_type.created

string | null

required

block_schema.block_type.id

string

required

block_schema.block_type.name

string

required

A block type's name

block_schema.block_type.slug

string

required

A block type's slug

block_schema.block_type.updated

string | null

required

block_schema.block_type.code_example

string | null

A code snippet demonstrating use of the corresponding block

block_schema.block_type.description

string | null

A short blurb about the corresponding block's intended use

block_schema.block_type.documentation_url

string | null

Web URL for the block type's documentation

block_schema.block_type.is_protected

boolean

default:

false

Protected block types cannot be modified via API.

block_schema.block_type.logo_url

string | null

Web URL for the block type's logo

block_schema.capabilities

string[]

A list of Block capabilities

block_schema.fields

object

The block schema's field schema

block_schema.version

string

default:

non-versioned

Human readable identifier for the block schema

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

block_type_name

string | null

The associated block type's name

data

object

The block document's data

is_anonymous

boolean

default:

false

Whether the block is anonymous (anonymous blocks are usually created by Prefect automatically)

name

string | null

The block document's name. Not required for anonymous block documents.