Health check
GET /health
Whether the register can answer. The Studio's connection test calls it first. Answer 200 with ok: true; ok: false makes the test report the register as unhealthy.
Authentication
- appsolut_m2m (sent in the header
x-api-key): The "API key" entered in the register's connection in the Studio, sent with every call. The Studio keeps it encrypted and never shows it again. Answer 401 or 403 to a wrong key.
Parameters
| Name | In | Required | Type | Description |
|---|---|---|---|---|
x-tenant-id | header | Yes | string | The "Tenant ID" entered in the register's connection in the Studio, sent unchanged with every call. Your register can use it to tell apart the organisations it serves. Example: pannoniqa. |
x-custom-scope | header | Yes | string | The "Scope" entered in the register's connection in the Studio, sent unchanged with every call. Your register can use it to choose the data set it answers from. Example: employees. |
Responses
200
The register's health.
Content type: application/json
| Field | Type | Required | Description |
|---|---|---|---|
ok | boolean | No | Whether the register can answer. false makes the connection test report it as unhealthy. |
ts | string | No | The register's time, for your own diagnosis. |
Example
{
"ok": true,
"ts": "2026-01-05T22:29:08.182Z"
}
400
The register could not process the request. The Studio treats it as the register being unavailable and does not read the body.
Content type: text/plain
Type: string
Example
Bad request
401
The API key is wrong. The Studio reports the credentials as rejected (it does the same for 403) and treats the register as unavailable.
Content type: text/plain
Type: string
Example
Unauthorized