prefect.server.api.admin

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

Functions

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

read_settings() -> prefect.settings.Settings

Get the current Prefect REST API settings.

Secret setting values will be obfuscated.

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

read_version() -> str

Returns the Prefect version number