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
Section titled “Methods”Check API Status
Section titled “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
Section titled “Example Request”curl -X GET "https://api.example.com/backend/api/v1/ping" \ -H "Authorization: Bearer YOUR_API_TOKEN"Example Response
Section titled “Example Response”{ "status": "healthy", "timestamp": "2026-02-12T14:30:45+00:00"}Response Fields
Section titled “Response Fields”| Field | Type | Description |
|---|---|---|
status | string | API health status. Returns healthy when operational |
timestamp | string | Current server time in ISO 8601 format |
Status Codes
Section titled “Status Codes”| Code | Description |
|---|---|
200 OK | API is healthy and responding |
401 Unauthorized | Invalid or missing Bearer token |