Read Block Documents

Query for block documents.

Headers

x-prefect-api-version

string

Body

application/json

block_documents

object | null

Filter BlockDocuments. Only BlockDocuments matching all criteria will be returned

Show child attributes

block_documents.block_type_id

object | null

Filter criteria for BlockDocument.block_type_id

Show child attributes

block_documents.block_type_id.any_

string[] | null

A list of block type ids to include

block_documents.id

object | null

Filter criteria for BlockDocument.id

Show child attributes

block_documents.id.any_

string[] | null

A list of block ids to include

block_documents.is_anonymous

object | null

Filter criteria for BlockDocument.is_anonymous. Defaults to excluding anonymous blocks.

Show child attributes

block_documents.is_anonymous.eq_

boolean | null

Filter block documents for only those that are or are not anonymous.

block_documents.name

object | null

Filter criteria for BlockDocument.name

Show child attributes

block_documents.name.any_

string[] | null

A list of block names to include

block_documents.name.like_

string | null

A string to match block names against. This can include SQL wildcard characters like % and _.

block_documents.operator

enum<string>

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

Available options:

and_,

or_

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.

block_types

object | null

Filter BlockTypes

Show child attributes

block_types.name

object | null

Filter criteria for BlockType.name

Show child attributes

block_types.name.like_

string | null

A case-insensitive partial match. For example, passing 'marvin' will match 'marvin', 'sad-Marvin', and 'marvin-robot'.

block_types.slug

object | null

Filter criteria for BlockType.slug

Show child attributes

block_types.slug.any_

string[] | null

A list of slugs to match

include_secrets

boolean

default:

false

Whether to include sensitive values in the block document.

limit

integer

Defaults to PREFECT_API_DEFAULT_LIMIT if not provided.

offset

integer

default:

0

Required range: x > 0

sort

enum<string> | null

default:

NAME_ASC

Defines block document sorting options.

Available options:

NAME_DESC,

NAME_ASC,

BLOCK_TYPE_AND_NAME_ASC

Response

200 - application/json

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.