prefect.server.api.block_schemas

Routes for interacting with block schema objects.

Functions

create_block_schema ^{<a href="https://github.com/PrefectHQ/prefect/blob/main/src/prefect/server/api/block_schemas.py#L28" target="_blank"><Icon icon="github" style="width: 14px; height: 14px;" /></a>}

create_block_schema(block_schema: schemas.actions.BlockSchemaCreate, response: Response, db: PrefectDBInterface = Depends(provide_database_interface)) -> schemas.core.BlockSchema

Create a block schema.

For more information, see https://docs.prefect.io/v3/concepts/blocks.

delete_block_schema ^{<a href="https://github.com/PrefectHQ/prefect/blob/main/src/prefect/server/api/block_schemas.py#L73" target="_blank"><Icon icon="github" style="width: 14px; height: 14px;" /></a>}

delete_block_schema(block_schema_id: UUID = Path(..., description='The block schema id', alias='id'), db: PrefectDBInterface = Depends(provide_database_interface), api_version: str = Depends(dependencies.provide_request_api_version)) -> None

Delete a block schema by id.

read_block_schemas ^{<a href="https://github.com/PrefectHQ/prefect/blob/main/src/prefect/server/api/block_schemas.py#L102" target="_blank"><Icon icon="github" style="width: 14px; height: 14px;" /></a>}

read_block_schemas(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.BlockSchema]

Read all block schemas, optionally filtered by type

read_block_schema_by_id ^{<a href="https://github.com/PrefectHQ/prefect/blob/main/src/prefect/server/api/block_schemas.py#L122" target="_blank"><Icon icon="github" style="width: 14px; height: 14px;" /></a>}

read_block_schema_by_id(block_schema_id: UUID = Path(..., description='The block schema id', alias='id'), db: PrefectDBInterface = Depends(provide_database_interface)) -> schemas.core.BlockSchema

Get a block schema by id.

read_block_schema_by_checksum ^{<a href="https://github.com/PrefectHQ/prefect/blob/main/src/prefect/server/api/block_schemas.py#L139" target="_blank"><Icon icon="github" style="width: 14px; height: 14px;" /></a>}

read_block_schema_by_checksum(block_schema_checksum: str = Path(..., description='The block schema checksum', alias='checksum'), db: PrefectDBInterface = Depends(provide_database_interface), version: Optional[str] = Query(None, description='Version of block schema. If not provided the most recently created block schema with the matching checksum will be returned.')) -> schemas.core.BlockSchema