Health check

Описание

Параметр HEALTH_CHECK_TOKEN используется для активации эндпоинта /api/v1/app/health-check, который проверяет состояние Пассворка. Для доступа к эндпоинту требуется передать токен — стандартная авторизация не используется. Если токен не задан, эндпоинт считается отключённым.

Активация

В файле config.env прописать следующий параметр с значением:

config.env

HEALTH_CHECK_TOKEN=custom_token

Конфигурационный файл config.env расположен в следующих директориях (в зависимости от выбора установки Пассворка):

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

Пример запроса

Linux

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"
    }'

Windows Server

Invoke-RestMethod -Uri "https://passwork.example.com/api/v1/app/health-check" `
  -Method Post `
  -Headers @{ 
    "Accept" = "application/json"
    "Content-Type" = "application/json" 
  } `
  -Body '{ "token": "custom_token" }'

Пример вывода

Linux

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

Windows Server

states        errors
------        ------
@{mongodb=ok} {}

Если полученный ответ от Пассворка в формате:

Linux

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

Windows Server

format content
------ -------
base64 eyJzdGF0ZXMiOnsibW9uZ29kYiI6Im9rIn0sImVycm9ycyI6W119

Необходимо расшифровать значение content:

Linux

# Команда
echo "eyJzdGF0ZXMiOnsibW9uZ29kYiI6Im9rIn0sImVycm9ycyI6W119" | base64 -d
# Вывод
{"states":{"mongodb":"ok"},"errors":[]}

Windows Server

# Команда
"eyJzdGF0ZXMiOnsibW9uZ29kYiI6Im9rIn0sImVycm9ycyI6W119" | ForEach-Object {
    [System.Text.Encoding]::UTF8.GetString([System.Convert]::FromBase64String($_))
}
# Вывод
{"states":{"mongodb":"ok"},"errors":[]}