PRprefecthq
Block documents

Create Block Document

Changed on

Create a new block document.

post/api/block_documents/

Request

  • The document declares no server URL.
  • Auth
    none declared

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

  • 93ae2b3f2efdRevision changes
    • breaking

      the request property became required

    • breaking

      the request property became required