Verificación de estado

Descripción general

El parámetro HEALTH_CHECK_TOKEN se utiliza para activar el endpoint /api/v1/app/health-check, que verifica el estado de Passwork. Para acceder al endpoint, se debe proporcionar un token — no se utiliza la autorización estándar. Si el token no está configurado, el endpoint se considera deshabilitado.

Activación

En el archivo config.env, especifique el siguiente parámetro con un valor:

config.env

HEALTH_CHECK_TOKEN=custom_token

El archivo de configuración config.env se encuentra en los siguientes directorios (según la opción de instalación de Passwork elegida):

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

Ejemplo de solicitud

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'

Ejemplo de salida

JSON

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

Si la respuesta recibida de Passwork tiene el formato:

base64

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

Es necesario decodificar el valor de content:

Linux

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