Solia Direct DocsControl Plane
⌘K

API ReferenceReference

Health endpoints

Exact request and response contracts for the health endpoints, generated from the enforced Partner API contract.

Machine-readable OpenAPI description

Endpoints in this group

GET/v1/healthVerify credentials and environment

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.

Responses

  • 200 — The key is valid.
  • 401 — Missing or invalid key.
json
{
  "data": {
    "status": "string",
    "version": "string",
    "environment": "sandbox",
    "server_time": "2026-01-15T14:32:07Z"
  },
  "request_id": "string",
  "cursor": "string"
}