mirror of
https://github.com/OliveTin/OliveTin
synced 2026-08-25 12:06:28 +00:00
jamesreadandCursor
c132eacc00
Move the docs.olivetin.app AsciiDoc component into this repository, add local Antora playbooks for contributors and CI, and document the split between this repo and the docs build repository. Co-authored-by: Cursor <cursoragent@cursor.com>
21 lines
476 B
Plaintext
21 lines
476 B
Plaintext
= Misc API calls
|
|
|
|
== Example API call: Get the dashboard buttons ("components")
|
|
|
|
.curl
|
|
----
|
|
user@host: curl http://olivetinServer:1337/api/GetDashboardComponents
|
|
----
|
|
|
|
== Example API call: readyz Healthcheck
|
|
|
|
This is useful for configuring healthchecks in docker containers, or on Kubernetes.
|
|
|
|
.curl
|
|
----
|
|
user@host: curl http://olivetinServer:1337/api/readyz
|
|
{"status": "ok"}
|
|
----
|
|
|
|
The response will always be "status: ok" to indicate that the API is up, or it will timeout.
|