Read Block Document By Id

Headers

x-prefect-api-version

string

Path Parameters

string

required

The block document id

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.

string

required

created

string | null

required

updated

string | null

required

block_schema_id

string

required

A block schema ID

block_type_id

string

required

A block type ID

name

string | null

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

data

object

The block document's data

block_schema

object | null

The associated block schema

block_type_name

string | null

The associated block type's name

block_type

object | null

The associated block type

block_document_references

object

Record of the block document's references

is_anonymous

boolean

default: false

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

APIs & SDK

Headers

Path Parameters

Query Parameters

Response