Health Check

Übersicht

Der Parameter HEALTH_CHECK_TOKEN wird verwendet, um den Endpunkt /api/v1/app/health-check zu aktivieren, der den Status von Passwork überprüft. Für den Zugriff auf den Endpunkt muss ein Token angegeben werden — die standardmäßige Autorisierung wird nicht verwendet. Wenn der Token nicht festgelegt ist, gilt der Endpunkt als deaktiviert.

Aktivierung

Geben Sie in der Datei config.env den folgenden Parameter mit einem Wert an:

config.env

HEALTH_CHECK_TOKEN=custom_token

Die Konfigurationsdatei config.env befindet sich in den folgenden Verzeichnissen (abhängig von der gewählten Passwork-Installation):

• Linux — /var/www/init/config.env
• Windows Server — C:\inetpub\wwwroot\passwork\init\config.env
• Docker — /<passwork>/conf/keys/config.env

Beispielanfrage

POST

curl --request POST \
  --url "https://passwork.example.com/api/v1/app/health-check" \
  --header 'Accept: application/json' \
  --header 'Content-Type: application/json' \
  --data '{
    "token": "custom_token"
    }'

GET

curl --request GET \
  --url "https://passwork.example.com/api/v1/app/health-check?token=custom_token" \
  --header 'Accept: application/json'

Beispielausgabe

JSON

{"states":{"mongodb":"ok"},"errors":[]}

Wenn die von Passwork empfangene Antwort im folgenden Format vorliegt:

base64

{
  "format": "base64",
  "content": "eyJzdGF0ZXMiOnsibW9uZ29kYiI6Im9rIn0sImVycm9ycyI6W119"
}

Müssen Sie den content-Wert dekodieren:

Linux

# Command
echo "eyJzdGF0ZXMiOnsibW9uZ29kYiI6Im9rIn0sImVycm9ycyI6W119" | base64 -d | jq .
# Output
{
  "states": {
    "mongodb": "ok"
  },
  "errors": []
}