specter-desktop/docs/api/ep_readyness.md
Kim Neunert 28e13ca93c
Documentation: hosted at docs.specter.solutions (#1463)
* mkdocs

* adding mkdocs for netlify

* fix theme

* link to Readme

* deleting symlink again

* deleting index.md

* fix release-notes

* several doc improvements and elements installation

* move DEVELOPMENT.md and CONTRIBUTING.md in subfolder

* multi-site setup

* changes site_dir

* revert

* adding mkdoc-wrapper.sh

* removing mkdocs from prod-requirements

* more docs

* fix test ... no more warning
2021-11-24 18:37:46 +01:00

546 B

Readyness Endpoint

This endpoint works as heathz-check. See e.g. here: https://kubernetes.io/docs/tasks/configure-pod-container/configure-liveness-readiness-startup-probes/

Other than the liveness-endpoint, this also checks whether specter is functional from a user-point of view (not only up and listening for requests).

URL : /api/healthz/readyness

Method : GET

Auth required : No

Permissions required : None

Success Response

Code : 200 OK

Content examples

{
  "message": "i am ready"
}