API & Integrations
Health check
5min
description the health check token parameter is used to enable the /api/v1/app/health check endpoint, which checks the status of passwork to access the endpoint, the token must be provided — standard authorization is not used if the token is not set, the endpoint is considered disabled activation in the config env file, write the following parameter with a value config env health check token=custom token the config env configuration file is located in the following directories, depending on the chosen passwork installation method linux — /var/www/init/config env windows server — c \inetpub\wwwroot\passwork\init\config env docker — /\<passwork>/conf/keys/config env example request 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" }' example output linux { "states" { "mongodb" "ok" }, "errors" \[] } windows server states errors \ @{mongodb=ok} {} if the response received from passwork is in the format linux { "format" "base64", "content" "eyjzdgf0zxmionsibw9uz29kyii6im9rin0simvycm9ycyi6w119" } windows server format content \ base64 eyjzdgf0zxmionsibw9uz29kyii6im9rin0simvycm9ycyi6w119 it is necessary to decipher the meaning of content linux # command echo "eyjzdgf0zxmionsibw9uz29kyii6im9rin0simvycm9ycyi6w119" | base64 d \# output {"states" {"mongodb" "ok"},"errors" \[]} windows server # command "eyjzdgf0zxmionsibw9uz29kyii6im9rin0simvycm9ycyi6w119" | foreach object { \[system text encoding] utf8 getstring(\[system convert] frombase64string($ )) } \# output {"states" {"mongodb" "ok"},"errors" \[]}