Sign in

v1

latestOpenAPI 3.1.0raw.githubusercontent.com2024-11-08170291390.5 KB
Block types

Read Block Type By Slug

Get a block type by name.

get/api/block_types/slug/{slug}

Path parameters

slugstring required

The block type name

The block type name

Headers

x-prefect-api-versionstring

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.