Trigger Drain Active Sessions — POST /api/v1/admin/maintenance/drain-active-live-sessions
Trigger Drain Active Sessions
Fire worker.tasks.drain_active_live_sessions immediately.
Endpoint: POST /api/v1/admin/maintenance/drain-active-live-sessions
Authentication: Send a signed-in user’s access token in Authorization: Bearer <access token>, or an API key in X-API-Key: <API key>.
- A minimum role applies. The source code names it.
Parameters
Section titled “Parameters”| Name | In | Required | Type | Default | Description |
|---|---|---|---|---|---|
X-API-Key | header | no | string or null | API key, as an alternative to the access token (see Authentication). |
Request body
Section titled “Request body”No request body.
Responses
Section titled “Responses”| Status | Meaning | Body |
|---|---|---|
200 | Successful Response | Not documented (application/json) |
422 | Validation Error | HTTPValidationError (application/json) |
Response fields not documented. The API specification does not describe the body of every response this endpoint returns, so this page cannot list those fields. The body is not empty. To see it, call the endpoint on your own installation. All endpoints with undocumented responses.
Errors this endpoint returns, read from its source code:
500
It can also return 401 if your credential is missing or expired, 403 if your credential does not allow this request, and 404 if the item does not exist or you cannot see it. Your role, your project membership and the key’s scope decide what a credential allows. See Errors and retries.
More details
Section titled “More details”- Group: Admin Maintenance
- Operation ID:
trigger_drain_active_sessions_api_v1_admin_maintenance_drain_active_live_sessions_post - Source code:
backend/app/routers/admin_maintenance.py, line 150 - Specification: OpenAPI JSON