Health/Status Endpoint for API Monitoring

feature-request

Please add a /health or /status endpoint to the Cycle.io API that returns the operational status of the service. This would enable proper health checking and monitoring for applications that integrate with Cycle.io.

Proposed endpoint: GET https://api.<customer_id>.cycle.io/health

Expected response:

{
  "status": "ok",
  "timestamp": "2025-10-17T17:00:00Z"
}

Use case: This endpoint would allow our services to implement readiness probes that verify Cycle.io API availability before accepting traffic, improving reliability and enabling circuit breaker patterns for graceful degradation when the API is unavailable.

HTTP status codes:

200 - Service operational
503 - Service unavailable (optional, for maintenance windows)

Hey Stephen,

Not a bad idea, let me circle back with the team and figure out what they have in mind for this.

Hey Stephen,

This has been completed in the next update, scheduled for later this week.

Example return is:

{
	"status": "ok",
	"time": "2025-11-02T23:18:45Z"
}

Please keep in mind this call is still subject to Cycle's API rate limits. Should you hit your limits, you'll receive a 429 with a standard error response.

Health/Status Endpoint for API Monitoring

Join the conversation

Cookies Preferences