Healthcheck

Use the healthcheck endpoint to inspect service status, engine versions, and environment-specific margin parameter metadata.

This endpoint is useful for operational checks, troubleshooting, and confirming the currently loaded business date and default analytics configuration before or after a calculation run.

GET/healthcheck/analytics-engine

Check analytics engine health

Returns an array of service health objects.

Common fields include:

service
status
version
healthcheck
start_time

Depending on the service, the response may also include:

last_business_date
parameters
global_app

The global_app block can expose useful defaults such as:

risk_metrics
simm_metrics
stress_sensitivities
currency_code
free_risk_rate

Example request:

cURL

curl -sSX GET "$C9_API_ENDPOINT/healthcheck/analytics-engine" \
  -H "Authorization: Bearer $C9_API_SECRET"

Example response:

[
  {
    "status": "OK",
    "healthcheck": 1776864774333,
    "start_time": "2026-04-19T10:47:48.555Z",
    "service": "client-api",
    "version": "0.0.302",
    "global_app": {
      "app_edition": "DEMO",
      "risk_metrics": {
        "ci": 99,
        "mode": "absolute",
        "mpor": 1,
        "method": "value-at-risk",
        "lookback": 250
      },
      "simm_metrics": {
        "version": "2_6",
        "holding_period": 10
      },
      "stress_sensitivities": {
        "shock_type": "absolute",
        "use_std_dev": true,
        "std_dev_mpor": 1,
        "std_dev_lookback": 250
      },
      "currency_code": "USD",
      "free_risk_rate": 0.01
    }
  },
  {
    "healthcheck": 1776864775900,
    "start_time": "2026-04-22T05:27:56.68Z",
    "service": "analytics",
    "last_business_date": 20260421,
    "version": "1.0.1",
    "status": "OK"
  }
]

The healthcheck response is service-specific. Not every engine returns the same extra fields, so your client should not assume a single fixed shape beyond the core status metadata.

Open the public healthcheck example