`prefect.server.api.block_types`

Functions

`create_block_type`

create_block_type(block_type: schemas.actions.BlockTypeCreate, db: PrefectDBInterface = Depends(provide_database_interface)) -> schemas.core.BlockType

Create a new block type. For more information, see https://docs.prefect.io/v3/concepts/blocks.

`read_block_type_by_id`

read_block_type_by_id(block_type_id: UUID = Path(..., description='The block type ID', alias='id'), db: PrefectDBInterface = Depends(provide_database_interface)) -> schemas.core.BlockType

Get a block type by ID.

`read_block_type_by_slug`

read_block_type_by_slug(block_type_slug: str = Path(..., description='The block type name', alias='slug'), db: PrefectDBInterface = Depends(provide_database_interface)) -> schemas.core.BlockType

Get a block type by name.

`read_block_types`

read_block_types(block_types: Optional[schemas.filters.BlockTypeFilter] = None, block_schemas: Optional[schemas.filters.BlockSchemaFilter] = None, limit: int = dependencies.LimitBody(), offset: int = Body(0, ge=0), db: PrefectDBInterface = Depends(provide_database_interface)) -> List[schemas.core.BlockType]

Gets all block types. Optionally limit return with limit and offset.

`update_block_type`

update_block_type(block_type: schemas.actions.BlockTypeUpdate, block_type_id: UUID = Path(..., description='The block type ID', alias='id'), db: PrefectDBInterface = Depends(provide_database_interface)) -> None

Update a block type.

`delete_block_type`

delete_block_type(block_type_id: UUID = Path(..., description='The block type ID', alias='id'), db: PrefectDBInterface = Depends(provide_database_interface)) -> None

`read_block_documents_for_block_type`

read_block_documents_for_block_type(db: PrefectDBInterface = Depends(provide_database_interface), block_type_slug: str = Path(..., description='The block type name', alias='slug'), include_secrets: bool = Query(False, description='Whether to include sensitive values in the block document.')) -> List[schemas.core.BlockDocument]

`read_block_document_by_name_for_block_type`

read_block_document_by_name_for_block_type(db: PrefectDBInterface = Depends(provide_database_interface), block_type_slug: str = Path(..., description='The block type name', alias='slug'), block_document_name: str = Path(..., description='The block type name'), include_secrets: bool = Query(False, description='Whether to include sensitive values in the block document.')) -> schemas.core.BlockDocument

`install_system_block_types`

install_system_block_types(db: PrefectDBInterface = Depends(provide_database_interface)) -> None

​prefect.server.api.block_types

​Functions

​create_block_type

​read_block_type_by_id

​read_block_type_by_slug

​read_block_types

​update_block_type

​delete_block_type

​read_block_documents_for_block_type

​read_block_document_by_name_for_block_type

​install_system_block_types