​
prefect.server.api.admin

Routes for admin-level interactions with the Prefect REST API.

​
Functions

​
read_settings 

read_settings() -> prefect.settings.Settings
Get the current Prefect REST API settings. Secret setting values will be obfuscated.

​
read_version 

read_version() -> str
Returns the Prefect version number

​
clear_database 

clear_database(db: PrefectDBInterface = Depends(provide_database_interface), confirm: bool = Body(False, embed=True, description='Pass confirm=True to confirm you want to modify the database.'), response: Response = None) -> None
Clear all database tables without dropping them.

​
drop_database 

drop_database(db: PrefectDBInterface = Depends(provide_database_interface), confirm: bool = Body(False, embed=True, description='Pass confirm=True to confirm you want to modify the database.'), response: Response = None) -> None
Drop all database objects.

​
create_database 

create_database(db: PrefectDBInterface = Depends(provide_database_interface), confirm: bool = Body(False, embed=True, description='Pass confirm=True to confirm you want to modify the database.'), response: Response = None) -> None
Create all database objects.