Block types
Read Block Type By Slug
Get a block type by name.
GET
/
api
/
block_types
/
slug
/
{slug}
Headers
x-prefect-api-version
string
Path Parameters
slug
string
requiredThe block type name
Response
200 - 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?