Ping

The ping endpoint lets you verify your API credentials are working correctly and check the API is responding. Use it for:

• Testing access - confirm your Bearer token authenticates successfully
• Uptime monitoring - integrate with monitoring systems to check API availability

Methods

GET

Check API Status

/backend/api/v1/ping - returns API health status and current server timestamp.

Authentication: Bearer token required. See Authentication for details.

Example Request

curl -X GET "https://api.example.com/backend/api/v1/ping" \
  -H "Authorization: Bearer YOUR_API_TOKEN"

Example Response

{
  "status": "healthy",
  "timestamp": "2026-02-12T14:30:45+00:00"
}

Response Fields

Status Codes