> ## Documentation Index
> Fetch the complete documentation index at: /docs/llms.txt
> Use this file to discover all available pages before exploring further.

# admin

# `prefect.server.api.admin`

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

## Functions

### `read_settings` <sup>[https://github.com/PrefectHQ/prefect/blob/main/src/prefect/server/api/admin.py#L18](https://github.com/PrefectHQ/prefect/blob/main/src/prefect/server/api/admin.py#L18)</sup>

```python theme={null}
read_settings() -> prefect.settings.Settings
```

Get the current Prefect REST API settings.

Secret setting values will be obfuscated.

### `read_version` <sup>[https://github.com/PrefectHQ/prefect/blob/main/src/prefect/server/api/admin.py#L28](https://github.com/PrefectHQ/prefect/blob/main/src/prefect/server/api/admin.py#L28)</sup>

```python theme={null}
read_version() -> str
```

Returns the Prefect version number

### `read_server_default_result_storage` <sup>[https://github.com/PrefectHQ/prefect/blob/main/src/prefect/server/api/admin.py#L34](https://github.com/PrefectHQ/prefect/blob/main/src/prefect/server/api/admin.py#L34)</sup>

```python theme={null}
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` <sup>[https://github.com/PrefectHQ/prefect/blob/main/src/prefect/server/api/admin.py#L45](https://github.com/PrefectHQ/prefect/blob/main/src/prefect/server/api/admin.py#L45)</sup>

```python theme={null}
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` <sup>[https://github.com/PrefectHQ/prefect/blob/main/src/prefect/server/api/admin.py#L78](https://github.com/PrefectHQ/prefect/blob/main/src/prefect/server/api/admin.py#L78)</sup>

```python theme={null}
clear_server_default_result_storage(db: PrefectDBInterface = Depends(provide_database_interface)) -> None
```

Clear the configured server default result storage block.
