Skip to main content

ping

The ping endpoint verifies that the service is reachable. This endpoint does not require authentication.

Endpoint

GET/api/v1/service-health/ping

Authentication

No authentication required.

Request Body

This endpoint does not accept a request body.

Response

Success Response (200)

200Success

Returns a service health pong response:

{
"status": "pong"
}

Response Fields

FieldTypeDescription
statusstringService health status. Returns pong when the service is reachable.

cURL Example

cURL Example
API_BASE_URL="<api-base-url>"

curl -s -X GET "$API_BASE_URL/api/v1/service-health/ping"