Sign in
Block documents

Create Block Document

Create a new block document.

post/api/block_documents/

Headers

x-prefect-api-versionstring

Request body

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

is_anonymousboolean

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

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)

Changes

Changed in 1 of the 50 revisions of this API.2

  • 93ae2b3f2efd2See the full diff
    • ▲

      the request property block_schema_id became required

      request-property-became-required

    • ▲

      the request property block_type_id became required

      request-property-became-required