prefect.server.api.saved_searches

Routes for interacting with saved search objects.

Functions

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

create_saved_search(saved_search: schemas.actions.SavedSearchCreate, response: Response, db: PrefectDBInterface = Depends(provide_database_interface)) -> schemas.core.SavedSearch

Creates a new saved search from the provided schema.

If a saved search with the same name already exists, the saved search's fields are replaced.

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

read_saved_search(saved_search_id: UUID = Path(..., description='The saved search id', alias='id'), db: PrefectDBInterface = Depends(provide_database_interface)) -> schemas.core.SavedSearch

Get a saved search by id.

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

read_saved_searches(limit: int = dependencies.LimitBody(), offset: int = Body(0, ge=0), db: PrefectDBInterface = Depends(provide_database_interface)) -> List[schemas.core.SavedSearch]

Query for saved searches.

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

delete_saved_search(saved_search_id: UUID = Path(..., description='The saved search id', alias='id'), db: PrefectDBInterface = Depends(provide_database_interface)) -> None

Delete a saved search by id.