Skip to content
Start building
Back

[SOLVED] How to use the Health endpoints

  • 0
  • Self Hosted
  • REST API
  • Cloud
View on Discord
Ibaraki Douji
29 Jan, 2026, 13:14

So i wanted to monitor everything on my appwrite instance tho it seams like there is no API scope available for thoses.

Looking at : https://appwrite.io/docs/references/1.8.x/server-nodejs/health I should be able to create an API key and use it to healthcheck if appwrite is still online. But i can't create an API key with the scope health.read which is required for thoses endpoint.

So now i would have multiple question. Is it possible to run a healthcheck ? on Cloud ? and on Self-Hosted ? If yes, how should we setup the keys ? (what scope are needed and if not in the UI how to enable them)

TL;DR
Solution: The developer was having trouble creating an API key with the `health.read` scope required to access the Health endpoints in Appwrite. Unfortunately, this API scope was not publicly available for use. As a result, they were unable to perform a health check on their Appwrite instance, both on Cloud and Self-Hosted.
Axistro
29 Jan, 2026, 13:25

Why unable to create api key with health?

Ibaraki Douji
29 Jan, 2026, 13:50

ok i'm holy blind then xpp. it's like the 10th time i check if it's on the API keys but never saw it. (either got patched in like 1.8.X where i didn't often checked that, or i was just blind as fuck)

also is there a reason why the healthcheck are not public ? (or at least one endpoint to know if the container is running for self-hosted)

Ibaraki Douji
29 Jan, 2026, 13:51

[SOLVED] How to use the Health endpoints

Reply

Reply to this thread by joining our Discord

Reply on Discord

Recommended threads

Need support?

Join our Discord

Get community support by joining our Discord server.

Join Discord

Get premium support

Join Appwrite Pro and get email support from our team.

Learn more