Ping - Health Check
Endpoint
/o/ping
Overview
Performs a minimal database-read probe and returns service reachability status.
Authentication
This endpoint accepts requests without API authentication parameters.
Permissions
This endpoint does not enforce role-based permission checks.
Request Parameters
This endpoint has no required query parameters.
Response
Success Response
{
"result": "Success"
}
Response Fields
| Field | Type | Description |
|---|---|---|
result | String | Success when DB probe completes without error. |
Error Responses
Status Code: 404 Not Found
{
"result": "DB Error"
}
Behavior/Processing
Behavior Modes
| Mode | Trigger | Response Shape |
|---|---|---|
| DB reachable | Probe query succeeds | Wrapped Success string. |
| DB probe failure | Probe query errors | Wrapped DB Error string with 404. |
Database Collections
| Collection | Used for | Data touched by this endpoint |
|---|---|---|
countly.plugins | DB liveness probe source | Reads one document (_id: "plugins"). |
Examples
Example 1: Ping API
/o/ping
{
"result": "Success"
}
Related Endpoints
Last Updated
2026-02-17