Zum Inhalt

GET /version

Endpunkt: GET /v1/pdapi/version

Auth: Bearer-Token

Berechtigung: REST.Version.Read

Zweck

Nutze diesen Endpunkt als Health-Check und Versionsprüfung für Tools, Dashboards und Skripte.

Pfadparameter

Keine.

Query-Parameter

Keine.

Request-Body

Kein Request-Body.

Antwortschema

Schema der 200-Antwort

Feld Typ Beschreibung
Version object Details zur PalDefender-Version.

Schema des Version-Objekts:

Feld Typ Beschreibung
Major integer Hauptversionsnummer.
Minor integer Nebenversionsnummer.
Patch integer Patch-Versionsnummer.
Build integer Buildnummer.
Version string Kurze Versionszeichenfolge.
VersionLong string Lange Versionszeichenfolge.
Beta boolean Gibt an, ob dieser Build als Beta gekennzeichnet ist.

Fehlerantworten

Fehlerantworten verwenden dieses Format:

{
    "Error": {
        "Code": "ERROR_CODE",
        "Message": "Für Menschen lesbare Nachricht",
        "Details": {}
    }
}
HTTP Fehlercode Wann es passiert
401 INVALID_TOKEN Der Authorization-Header fehlt, ist fehlerhaft oder passt zu keinem konfigurierten Bearer-Token.
403 MISSING_PERMISSION Das Token ist gültig, enthält aber nicht die Berechtigung für diesen Endpunkt.

Beispiele

Zustands- und Versionsprüfung

GET /v1/pdapi/version

Szenarien

  • Nutze ihn nach dem Konfigurieren des REST-API-Tokens, um die Authentifizierung zu prüfen.
  • Nutze ihn vor weiteren Endpunktaufrufen, wenn dein Tool eine Mindestversion von PalDefender benötigt.
  • Nutze ihn für Monitoring, da es der kleinste schreibgeschützte Request ist.