4
0

misc.adoc 476 B

1234567891011121314151617181920
  1. = Misc API calls
  2. == Example API call: Get the dashboard buttons ("components")
  3. .curl
  4. ----
  5. user@host: curl http://olivetinServer:1337/api/GetDashboardComponents
  6. ----
  7. == Example API call: readyz Healthcheck
  8. This is useful for configuring healthchecks in docker containers, or on Kubernetes.
  9. .curl
  10. ----
  11. user@host: curl http://olivetinServer:1337/api/readyz
  12. {"status": "ok"}
  13. ----
  14. The response will always be "status: ok" to indicate that the API is up, or it will timeout.