Skip to main content

Documentation Index

Fetch the complete documentation index at: https://docs.prefect.io/llms.txt

Use this file to discover all available pages before exploring further.

​
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

​
read_server_default_result_storage 

read_server_default_result_storage(db: PrefectDBInterface = Depends(provide_database_interface)) -> schemas.core.ServerDefaultResultStorage
Get the configured server default result storage block.

​
update_server_default_result_storage 

update_server_default_result_storage(configuration: schemas.core.ServerDefaultResultStorageUpdate, db: PrefectDBInterface = Depends(provide_database_interface)) -> schemas.core.ServerDefaultResultStorage
Set the server default result storage block.

​
clear_server_default_result_storage 

clear_server_default_result_storage(db: PrefectDBInterface = Depends(provide_database_interface)) -> None
Clear the configured server default result storage block.