Skip to main content

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.

Examples

Example 1: Ping API

/o/ping
{
"result": "Success"
}

Response

Success Response

{
"result": "Success"
}

Response Fields

FieldTypeDescription
resultStringSuccess when DB probe completes without error.

Error Responses

Status Code: 404 Not Found

{
"result": "DB Error"
}

Behavior

Behavior Modes

ModeTriggerResponse Shape
DB reachableProbe query succeedsWrapped Success string.
DB probe failureProbe query errorsWrapped DB Error string with 404.
Implementation details

Database Collections

CollectionUsed forData touched by this endpoint
countly.pluginsDB liveness probe sourceReads one document (_id: "plugins").