PRprefecthq
Block types

Create Block Type

Changed on

Create a new block type

post/api/block_types/

Request

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

Headers

x-prefect-api-versionstring

Request body

namestring required

A block type's name

slugstring required

A block type's slug

logo_urlstring uri

Web URL for the block type's logo

documentation_urlstring uri

Web URL for the block type's documentation

descriptionstring

A short blurb about the corresponding block's intended use

code_examplestring

A code snippet demonstrating use of the corresponding block

Response

Successful Response

idstring uuid
createdstring date-time
updatedstring date-time
namestring required

A block type's name

slugstring required

A block type's slug

logo_urlstring uri

Web URL for the block type's logo

documentation_urlstring uri

Web URL for the block type's documentation

descriptionstring

A short blurb about the corresponding block's intended use

code_examplestring

A code snippet demonstrating use of the corresponding block

is_protectedboolean

Protected block types cannot be modified via API.

Changes