Block types
Create Block Type
Create a new block type
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
requiredA block type's name
slug
string
requiredA block type's slug
logo_url
string | null
Web URL for the block type's logo
documentation_url
string | null
Web URL for the block type's documentation
description
string | null
A short blurb about the corresponding block's intended use
code_example
string | null
A code snippet demonstrating use of the corresponding block
Response
201 - application/json
An ORM representation of a block type
id
string
created
string | null
updated
string | null
name
string
requiredA block type's name
slug
string
requiredA block type's slug
logo_url
string | null
Web URL for the block type's logo
documentation_url
string | null
Web URL for the block type's documentation
description
string | null
A short blurb about the corresponding block's intended use
code_example
string | null
A code snippet demonstrating use of the corresponding block
is_protected
boolean
default: falseProtected block types cannot be modified via API.
Was this page helpful?