Update system health API docs to clarify authentication requirements (#34086)

Clarified that authentication is not required for the /api/v4/system/ping
endpoint. Documented three response scenarios:
- Basic response (no auth, no parameters)
- Enhanced response with get_server_status=true (no auth required)
- Admin response with get_server_status=true and manage_system permission

Fixes MM-66073
This commit is contained in:
Jesse Hallam
2025-10-14 12:50:25 -04:00
committed by GitHub
parent c3c292f8de
commit 144face19f
+20 -2
View File
@@ -54,12 +54,30 @@
##### Permissions
None.
None. Authentication is not required for this endpoint.
##### Response Details
The response varies based on query parameters and authentication:
- **Basic response** (no parameters): Returns basic server information including
`status`, mobile app versions, and active search backend.
- **Enhanced response** (`get_server_status=true`): Additionally returns
`database_status` and `filestore_status` to verify backend connectivity.
Authentication is not required.
- **Admin response** (`get_server_status=true` with `manage_system` permission):
Additionally returns `root_status` indicating whether the server is running as root.
Requires authentication with `manage_system` permission.
operationId: GetPing
parameters:
- name: get_server_status
in: query
description: Check the status of the database and file storage as well
description: >
Check the status of the database and file storage as well.
When true, adds `database_status` and `filestore_status` to the response.
If authenticated with `manage_system` permission, also adds `root_status`.
required: false
schema:
type: boolean