> ## 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.
# clients
# `prefect.server.api.clients`
## Classes
### `BaseClient`
### `OrchestrationClient`
**Methods:**
#### `create_flow_run`
```python theme={null}
create_flow_run(self, deployment_id: UUID, flow_run_create: DeploymentFlowRunCreate) -> Response
```
#### `delete_flow_run`
```python theme={null}
delete_flow_run(self, flow_run_id: UUID) -> Response
```
#### `pause_deployment`
```python theme={null}
pause_deployment(self, deployment_id: UUID) -> Response
```
#### `pause_work_pool`
```python theme={null}
pause_work_pool(self, work_pool_name: str) -> Response
```
#### `pause_work_queue`
```python theme={null}
pause_work_queue(self, work_queue_id: UUID) -> Response
```
#### `read_block_document_raw`
```python theme={null}
read_block_document_raw(self, block_document_id: UUID, include_secrets: bool = True) -> Response
```
#### `read_concurrency_limit_v2_raw`
```python theme={null}
read_concurrency_limit_v2_raw(self, concurrency_limit_id: UUID) -> Response
```
#### `read_deployment`
```python theme={null}
read_deployment(self, deployment_id: UUID) -> Optional[DeploymentResponse]
```
#### `read_deployment_raw`
```python theme={null}
read_deployment_raw(self, deployment_id: UUID) -> Response
```
#### `read_flow_raw`
```python theme={null}
read_flow_raw(self, flow_id: UUID) -> Response
```
#### `read_flow_run_raw`
```python theme={null}
read_flow_run_raw(self, flow_run_id: UUID) -> Response
```
#### `read_task_run_raw`
```python theme={null}
read_task_run_raw(self, task_run_id: UUID) -> Response
```
#### `read_work_pool`
```python theme={null}
read_work_pool(self, work_pool_id: UUID) -> Optional[WorkPool]
```
#### `read_work_pool_raw`
```python theme={null}
read_work_pool_raw(self, work_pool_id: UUID) -> Response
```
#### `read_work_queue_raw`
```python theme={null}
read_work_queue_raw(self, work_queue_id: UUID) -> Response
```
#### `read_work_queue_status_raw`
```python theme={null}
read_work_queue_status_raw(self, work_queue_id: UUID) -> Response
```
#### `read_workspace_variables`
```python theme={null}
read_workspace_variables(self, names: Optional[List[str]] = None) -> Dict[str, StrictVariableValue]
```
#### `request`
```python theme={null}
request(self, method: HTTP_METHODS, path: 'ServerRoutes', params: dict[str, Any] | None = None, path_params: dict[str, Any] | None = None, **kwargs: Any) -> 'Response'
```
#### `resume_deployment`
```python theme={null}
resume_deployment(self, deployment_id: UUID) -> Response
```
#### `resume_flow_run`
```python theme={null}
resume_flow_run(self, flow_run_id: UUID) -> OrchestrationResult
```
#### `resume_work_pool`
```python theme={null}
resume_work_pool(self, work_pool_name: str) -> Response
```
#### `resume_work_queue`
```python theme={null}
resume_work_queue(self, work_queue_id: UUID) -> Response
```
#### `set_flow_run_state`
```python theme={null}
set_flow_run_state(self, flow_run_id: UUID, state: StateCreate, force: bool = False) -> Response
```
### `WorkPoolsOrchestrationClient`
**Methods:**
#### `read_work_pool`
```python theme={null}
read_work_pool(self, work_pool_name: str) -> WorkPool
```
Reads information for a given work pool
Args:
work\_pool\_name: The name of the work pool to for which to get
information.
Returns:
Information about the requested work pool.
#### `request`
```python theme={null}
request(self, method: HTTP_METHODS, path: 'ServerRoutes', params: dict[str, Any] | None = None, path_params: dict[str, Any] | None = None, **kwargs: Any) -> 'Response'
```