Sign in

v1

latestOpenAPI 3.1.0raw.githubusercontent.com2024-11-08170291390.5 KB
Block documents

Read Block Document By Id

get/api/block_documents/{id}

Path parameters

idstring uuid required

The block document id

The block document id

Query parameters

include_secretsboolean

Whether to include sensitive values in the block document.

Whether to include sensitive values in the block document.

Headers

x-prefect-api-versionstring

Response

Successful Response

idstring uuid
createdstring date-time
updatedstring date-time
namestring

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

dataobject

The block document's data

block_schema_idstring uuid required

A block schema ID

block_type_idstring uuid required

A block type ID

block_type_namestring

The associated block type's name

block_document_referencesobject

Record of the block document's references

is_anonymousboolean

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