Health-Check
GET /health
Ob das Register antworten kann. Der Verbindungstest des Studios ruft ihn zuerst auf. Antworten Sie mit 200 und ok: true; ok: false lässt den Test das Register als nicht betriebsbereit melden.
Authentifizierung
- appsolut_m2m (im Header
x-api-keygesendet): Der „API-Schlüssel“, der in der Anbindung des Registers im Studio eingetragen ist, bei jedem Aufruf gesendet. Das Studio speichert ihn verschlüsselt und zeigt ihn nie wieder an. Antworten Sie auf einen falschen Schlüssel mit 401 oder 403.
Parameter
| Name | Ort | Pflicht | Typ | Beschreibung |
|---|---|---|---|---|
x-tenant-id | Header | Ja | string | Die „Mandanten-ID“, die in der Anbindung des Registers im Studio eingetragen ist, bei jedem Aufruf unverändert gesendet. Ihr Register kann damit die Organisationen unterscheiden, die es bedient. Beispiel: pannoniqa. |
x-custom-scope | Header | Ja | string | Der „Scope“, der in der Anbindung des Registers im Studio eingetragen ist, bei jedem Aufruf unverändert gesendet. Ihr Register kann damit den Datenbestand wählen, aus dem es antwortet. Beispiel: employees. |
Antworten
200
Der Zustand des Registers.
Inhaltstyp: application/json
| Feld | Typ | Pflicht | Beschreibung |
|---|---|---|---|
ok | boolean | Nein | Ob das Register antworten kann. false lässt den Verbindungstest es als nicht betriebsbereit melden. |
ts | string | Nein | Die Uhrzeit des Registers, für Ihre eigene Diagnose. |
Beispiel
{
"ok": true,
"ts": "2026-01-05T22:29:08.182Z"
}
400
Das Register konnte die Anfrage nicht verarbeiten. Das Studio behandelt das Register dann als nicht erreichbar und liest den Inhalt nicht.
Inhaltstyp: text/plain
Typ: string
Beispiel
Bad request
401
Der API-Schlüssel ist falsch. Das Studio meldet die Zugangsdaten als abgelehnt (ebenso bei 403) und behandelt das Register als nicht erreichbar.
Inhaltstyp: text/plain
Typ: string
Beispiel
Unauthorized