Block documents
Read Block Document By Id
GET
/
api
/
block_documents
/
{id}
Headers
x-prefect-api-version
string
Path Parameters
id
string
requiredThe block document id
Query Parameters
include_secrets
boolean
default: falseWhether to include sensitive values in the block document.
Response
200 - application/json
An ORM representation of a block document.
id
string
created
string | null
updated
string | null
name
string | null
The block document's name. Not required for anonymous block documents.
data
object
The block document's data
block_schema_id
string
requiredA block schema ID
block_schema
object | null
The associated block schema
block_type_id
string
requiredA block type ID
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: falseWhether the block is anonymous (anonymous blocks are usually created by Prefect automatically)
Was this page helpful?