cc
GET /system/health

Unauthenticated. Returns overall system status and per-dependency health. Used by monitoring and uptime checks.

Responses

  • 200 application/json

    System healthy or degraded

    Hide response attributes Show response attributes object
    • status string Required

      Values are ok, degraded, or down.

    • checked_at string(date-time) Required
    • dependencies array[object] Required
      Hide dependencies attributes Show dependencies attributes object
      • name string Required

        Maximum length is 100.

      • status string Required

        Values are ok, degraded, or down.

      • message string | null

        Maximum length is 500.
  • 503 application/json

    System is down

    Hide response attributes Show response attributes object
    • status string Required

      Values are ok, degraded, or down.

    • checked_at string(date-time) Required
    • dependencies array[object] Required
      Hide dependencies attributes Show dependencies attributes object
      • name string Required

        Maximum length is 100.

      • status string Required

        Values are ok, degraded, or down.

      • message string | null

        Maximum length is 500.
  • 429 application/json

    Too many requests. Retry after the indicated number of seconds.

    Hide headers attributes Show headers attributes
    • Retry-After integer

      Seconds to wait before retrying

    • X-RateLimit-Limit

      Maximum requests allowed in the current window

    • X-RateLimit-Remaining

      Requests remaining in the current window

    • X-RateLimit-Reset

      Unix timestamp when the rate limit window resets

    Hide response attributes Show response attributes object
    • code string Required

      Machine-readable error code (snake_case)

      Maximum length is 100.

    • message string Required

      Human-readable error summary

      Maximum length is 500.

    • details object Required

      Structured context for the error. Always an object, never null. Empty object {} when no additional detail is available.

      Additional properties are allowed.
  • default application/json

    Unexpected server error

    Hide response attributes Show response attributes object
    • code string Required

      Machine-readable error code (snake_case)

      Maximum length is 100.

    • message string Required

      Human-readable error summary

      Maximum length is 500.

    • details object Required

      Structured context for the error. Always an object, never null. Empty object {} when no additional detail is available.

      Additional properties are allowed.
GET /system/health 
curl \
 --request GET 'https://sampleplatform.ccextractor.org/api/v1/system/health'
Response examples (200) 
{
  "status": "ok",
  "checked_at": "2026-05-04T09:42:00Z",
  "dependencies": [
    {
      "name": "string",
      "status": "ok",
      "message": "string"
    }
  ]
}
Response examples (503) 
{
  "status": "ok",
  "checked_at": "2026-05-04T09:42:00Z",
  "dependencies": [
    {
      "name": "string",
      "status": "ok",
      "message": "string"
    }
  ]
}
Response examples (429) 
{
  "code": "rate_limited",
  "message": "Rate limit exceeded. Retry after 30 seconds.",
  "details": {
    "retry_after": 30,
    "limit": 120,
    "window": "60s"
  }
}
Response examples (default) 
{
  "code": "not_found",
  "message": "Run 9317 not found.",
  "details": {}
}