Skip to main content
GET
Get public API health

Auf einen Blick

Betriebsverhalten

Gibt die aktuelle Verfügbarkeit der Public API zurück.
  • Diese öffentliche Prüfung validiert weder einen API-Key noch Tenant-Scope oder Zugriff auf geschützte Ressourcen.

Häufige Fehler

Die Response-Liste der Operation und die Seite Fehlerbehandlung sind für die vollständige Behandlung maßgeblich.

Vor der Implementierung

  • Erzeugen und protokollieren Sie für den Versuch eine neue X-Request-ID.
  • Behandeln Sie jeden dokumentierten Response-Status.
  • Protokollieren Sie keine unnötigen personenbezogenen Daten.

Zugehöriger Integrationsleitfaden

Prüfen Sie den vollständigen Einstiegspfad für Erreichbarkeit, Authentifizierung und geschützte Requests.

Header

X-Request-ID
string<uuid>
inactive
optional
not sent by default

Optional request identifier. If supplied, it must be a UUID v4 or v7 and is returned unchanged in every response. If omitted, the API generates one. Invalid values return 400 INVALID_REQUEST_ID. If your client uses a {{requestId}} variable, refresh it with a new UUID version 4 or 7 for every HTTP request attempt. Keep the header disabled to let the API generate the request identifier.

Pattern: ^[0-9a-fA-F]{8}-[0-9a-fA-F]{4}-[47][0-9a-fA-F]{3}-[89aAbB][0-9a-fA-F]{3}-[0-9a-fA-F]{12}$

Antwort

The public API is available.

Availability status returned when the public API is healthy.

status
enum<string>
erforderlich

Current public API availability state.

Verfügbare Optionen:
up
Minimum string length: 1
Beispiel:

"up"

timestamp
string<date-time>
erforderlich

UTC timestamp for when the health evaluation completed.

Minimum string length: 1
Pattern: Z$
Beispiel:

"2026-07-09T12:00:00.000Z"

Zuletzt geändert am 27. August 2026