ReferenceReference
Health endpoints
Exact request and response contracts for the health endpoints, generated from the enforced Partner API contract.
Machine-readable OpenAPI descriptionOn this page
Endpoints in this group
/v1/healthVerify credentials and environmentImportant
Base path: /api/public/partner/v1. Every response carries request_id; every failure uses the standard error envelope documented under Errors.
GET/v1/health
Verify credentials and environment
Authentication & scope
- Authentication:
Authorization: Bearer <API key>. The key is bound to one laboratory, one API client and one environment. - No resource scope is required beyond a valid, active key.
Synthetic schema examples are illustrative, not eligible records. Set PROGRAM_ID and ITEM_ID from granted Programs/Catalog, ORDER_ID and RESULT_ID from current responses, and EXTERNAL_SUBJECT_ID to an opaque synthetic reference. Replace body identifiers with authorized records and include patient/provider/question fields only when current requirements request them. Use Sandbox; Production requires separate approval.
cURL
curl -s "$SOLIA_API_BASE/health" \
-H "Authorization: Bearer $SOLIA_API_KEY"Responses
- 200 — The key is valid.
- 401 — Missing or invalid key.
- 403 — Client, environment or scope denied.
- 429 — Per-instance client rate limit exceeded; honor Retry-After.
- 500 — Canonical request failed; reconcile uncertain actions.
- 503 — Required API configuration is unavailable.
{
"data": {
"status": "synthetic",
"version": "synthetic",
"environment": "sandbox",
"server_time": "2026-10-19T00:00:00Z"
},
"request_id": "synthetic"
}