> ## Documentation Index
> Fetch the complete documentation index at: https://docs.truthlocks.com/llms.txt
> Use this file to discover all available pages before exploring further.

# Programmatischer Status

> Echtzeit-Dienstzustand für alle Truthlocks-Dienste abfragen. Keine Authentifizierung erforderlich.

Gibt den aktuellen Gesundheitsstatus jedes Truthlocks-Dienstes zurück. Verwenden Sie diesen Endpunkt, um die Dienstverfügbarkeit in Ihre eigenen Dashboards, Alarmierungs-Pipelines oder Schutzschalter zu integrieren.

Dieser Endpunkt wird von `status.truthlocks.com` und nicht von der Haupt-API bereitgestellt. Es ist keine Authentifizierung erforderlich.

```http theme={null}
GET https://status.truthlocks.com/api/health
```

### Antwortfelder

| Feld | Typ | Beschreibung |
| - | - | - |
| `status` | string | Gesamtsystemzustand: `operational`, `degraded` oder `outage`. |
| `timestamp` | string | ISO 8601 Zeitstempel der Prüfung. |
| `services` | array | Gesundheitsergebnisse pro Dienst. |
| `services[].id` | string | Maschinenlesbare Dienstkennung (z. B. `api-gateway`, `signing-service`). |
| `services[].name` | string | Menschenlesbarer Dienstname. |
| `services[].status` | string | Dienstzustand: `operational`, `degraded` oder `outage`. |
| `services[].responseTime` | number or null | Antwortzeit in Millisekunden, oder `null`, wenn unerreichbar. |
| `services[].error` | string | Nur vorhanden, wenn der Dienst nicht betriebsbereit ist. Beschreibt den Fehlergrund. |

### Statuslogik

* **`operational`** – alle Dienste sind fehlerfrei und reagieren normal.
* **`degraded`** – mindestens ein Dienst ist langsam oder gibt Fehler zurück, aber keiner ist vollständig ausgefallen.
* **`outage`** – mindestens ein Dienst ist vollständig unerreichbar.

### Überwachte Dienste

| Dienst-ID | Name | Beschreibung |
| - | - | - |
| `api-gateway` | API Gateway | Haupt-API-Endpunkt für alle öffentlichen Anfragen |
| `trust-registry` | Vertrauensregister | Ausstellerverwaltung und -governance |
| `billing-service` | Abrechnung | Abonnement- und Zahlungsabwicklung |
| `signing-service` | Signieren | Kryptografische Signaturvorgänge |
| `attestation-service` | Attestierungen | Prägung und Verwaltung von Attestierungen |
| `audit-service` | Audit-Protokolle | Aktivitätsprotokollierung und Compliance |
| `transparency-log` | Transparenzprotokoll | Kryptografisches Nur-Anhängen-Protokoll |
| `verification-service` | Verifizierung | Überprüfung des Nachweispakets |

### Beispiel: Statusabfrage von Ihrer Anwendung

```javascript theme={null}
async function checkTruthlockStatus() {
  const res = await fetch("https://status.truthlocks.com/api/health");
  const data = await res.json();

  if (data.status !== "operational") {
    console.warn(`Truthlocks is ${data.status}`);
    const issues = data.services.filter((s) => s.status !== "operational");
    issues.forEach((s) =>
      console.warn(`  ${s.name}: ${s.status} — ${s.error}`)
    );
  }

  return data;
}
```

### Beispiel: Vorabprüfung vor der Prägung

```javascript theme={null}
async function mintWithStatusCheck(attestation) {
  const status = await fetch("https://status.truthlocks.com/api/health");
  const health = await status.json();

  const signingService = health.services.find(
    (s) => s.id === "signing-service"
  );
  const attestationService = health.services.find(
    (s) => s.id === "attestation-service"
  );

  if (
    signingService?.status !== "operational" ||
    attestationService?.status !== "operational"
  ) {
    throw new Error("Required services are not operational — retry later");
  }

  return client.attestations.mint(attestation);
}
```

> [!NOTE]
>
> Dieser Endpunkt ist ratenbegrenzt, um Missbrauch zu verhindern. Für die kontinuierliche Überwachung, Abfrage
> nicht häufiger als einmal alle 30 Sekunden.


## OpenAPI

````yaml de/mint-openapi.yaml GET /api/health
openapi: 3.0.3
info:
  title: Truthlocks API
  description: >
    Truthlocks ist eine universelle Verifizierungsinfrastruktur für Dokumente,
    Anmeldeinformationen und digitale Assets.

    Diese Spezifikation definiert die kanonische API für die Interaktion mit
    Truthlocks-Diensten.


    ## Basis-URLs

    - **Produktion**: `https://api.truthlocks.com`

    - **Sandbox**: `https://sandbox-api.truthlocks.com`


    ## Authentifizierung

    - **API-Schlüssel**: Verwenden Sie den Header `X-API-Key` für
    Machine-to-Machine-Operationen

    - **Bearer Tokens**: Verwenden Sie `Authorization: Bearer <jwt>` für
    benutzerinitiierte Operationen


    ## Mandantenidentität

    In der Produktion wird die Mandantenidentität aus dem authentifizierten
    Kontext (API-Schlüssel oder JWT) abgeleitet.

    Der Header `X-Tenant-ID` wird in der Produktion ignoriert, um Spoofing zu
    verhindern.
  version: 1.0.0
  contact:
    name: Truthlocks Support
    url: https://truthlocks.com/support
    email: support@truthlocks.com
servers:
  - url: https://api.truthlocks.com
    description: Produktions-API
  - url: https://sandbox-api.truthlocks.com
    description: Sandbox-Umgebung
security:
  - APIKey: []
  - BearerAuth: []
tags:
  - name: Authentication
    description: API-Schlüssel- und Token-Verwaltung
  - name: Issuers
    description: Ausstellerregistrierung und Vertrauensmanagement
  - name: Keys
    description: Kryptographische Schlüsselverwaltung für Aussteller
  - name: Attestations
    description: Bestätigungslebenszyklus (prägen, widerrufen, ersetzen)
  - name: Verification
    description: Bestätigungsverifizierung und Proof-Bundles
  - name: Governance
    description: Aussteller-Governance-Workflows (nur Admin)
  - name: Identity
    description: Organisations-, Benutzer- und Rollenverwaltung
  - name: Audit
    description: Audit-Ereignisabfragen
  - name: Tenant Console
    description: Mandantenprofil- und Lebenszyklus-Endpunkte
  - name: Health
    description: Endpunkte für Dienststatus und Bereitschaft
  - name: Risk
    description: Erfassung von Risikosignalen und Betrugserkennung
  - name: Risk Enforcement
    description: >-
      Risikodurchsetzungsmaßnahmen – Blockieren, Herausfordern, Quarantäne und
      Konfiguration
  - name: Billing
    description: Verwaltung von Abrechnung, Abonnements und Add-ons
  - name: Machine Identity
    description: >-
      Machine Agent Identity Protocol (MAIP) – Agentenregistrierung, Sitzungen,
      Vertrauen, Zeugen, Compliance, Orchestrierung und Beobachtbarkeit
externalDocs:
  description: Transparenz-API nur lesend (separate Dienstspezifikation)
  url: >-
    https://github.com/truthlocks/truthlock/blob/main/docs/transparency/openapi.yaml
paths:
  /api/health:
    get:
      tags:
        - Health
      summary: Programmatischer Status
      description: >-
        Gibt den Echtzeit-Dienstzustand für alle Truthlocks-Dienste zurück.
        Keine Authentifizierung erforderlich.
      operationId: health.status
      responses:
        '200':
          description: Dienststatus
          content:
            application/json:
              schema:
                type: object
                properties:
                  status:
                    type: string
                    enum:
                      - operational
                      - degraded
                      - outage
                  timestamp:
                    type: string
                    format: date-time
                  services:
                    type: array
                    items:
                      type: object
                      properties:
                        id:
                          type: string
                        name:
                          type: string
                        status:
                          type: string
                        responseTime:
                          nullable: true
                          type: integer
                        lastChecked:
                          type: string
                          format: date-time
                        error:
                          type: string
                          description: >-
                            Wird angezeigt, wenn ein Health Check einen Fehler
                            meldet.
      security: []
      servers:
        - url: https://status.truthlocks.com
components:
  securitySchemes:
    APIKey:
      type: apiKey
      in: header
      name: X-API-Key
      description: API-Schlüssel für die Maschine-zu-Maschine-Authentifizierung
    BearerAuth:
      type: http
      scheme: bearer
      bearerFormat: JWT
      description: JWT für benutzerinitiierte Operationen

````

This documentation is built and hosted on [Mintlify](https://mintlify.com), a developer documentation platform.