POST
/
api
/
block_types

Headers

x-prefect-api-version
string

Body

application/json

Data used by the Prefect REST API to create a block type.

name
string
required

A block type's name

slug
string
required

A block type's slug

code_example
string | null

A code snippet demonstrating use of the corresponding block

description
string | null

A short blurb about the corresponding block's intended use

documentation_url
string | null

Web URL for the block type's documentation

logo_url
string | null

Web URL for the block type's logo

Response

201 - application/json

An ORM representation of a block type

created
string | null
required
id
string
required
name
string
required

A block type's name

slug
string
required

A block type's slug

updated
string | null
required
code_example
string | null

A code snippet demonstrating use of the corresponding block

description
string | null

A short blurb about the corresponding block's intended use

documentation_url
string | null

Web URL for the block type's documentation

is_protected
boolean
default:
false

Protected block types cannot be modified via API.

logo_url
string | null

Web URL for the block type's logo