Skip to content
Sign in
Sign in

GET /health

The first call of every live check. If this fails, Rubi does not call traders, accounts, trades or payouts.

Paths are relative to your base URL
Rubi joins the base URL saved under Integrations with the path on this page. Save https://risk.example-firm.com/rubi/v1 with no trailing slash. GET /traders is then requested as https://risk.example-firm.com/rubi/v1/traders.

Shared rules for authentication, pagination, errors and the live check are on the Own tech overview.

GET/health

Returns { "status": "ok" }

Every call, including GET /health, sends Authorization: Bearer <api key> and Accept: application/json. The key is the secret you paste in the dashboard. Rubi never sends a body: every endpoint is GET.

No query parameters. Rubi retries this call at most twice.

request
curl https://risk.example-firm.com/rubi/v1/health \
  -H "Authorization: Bearer $PROVIDER_KEY" \
  -H "Accept: application/json"
200 response
{
  "status": "ok",
  "provider": "Example Firm Risk API",
  "version": "1"
}

Rules#

  • status must be the string ok. Any other value, a missing field, or a non-JSON body fails the check with the message that GET /health must return { "status": "ok" }.
  • provider and version are optional. Rubi does not read them.
  • Answer 401 when the bearer key is missing or wrong, the same as the other endpoints.
  • Keep this handler cheap. It is called on every connection test, before the heavier list probes.