The Health service is designed to allow you to both validate and monitor that your Appwrite instance and all of its internal components are up and responsive.
https://<REGION>.cloud.appwrite.io/v1
Get Antivirus
Check the Appwrite Antivirus server is up and connection is successful.
Response
200 application/json
GET /health/anti-virus
GET /v1/health/anti-virus HTTP/1.1
Host: HOSTNAME
Content-Type: application/json
X-Appwrite-Response-Format: 1.0.0
X-Appwrite-Project: 5df5acd0d48c2
X-Appwrite-Key: 919c2d18fb5d4...a2ae413da83346ad2
Get Cache
Check the Appwrite in-memory cache server is up and connection is successful.
Response
200 application/json
GET /health/cache
GET /v1/health/cache HTTP/1.1
Host: HOSTNAME
Content-Type: application/json
X-Appwrite-Response-Format: 1.0.0
X-Appwrite-Project: 5df5acd0d48c2
X-Appwrite-Key: 919c2d18fb5d4...a2ae413da83346ad2
Get Certificates Queue
Get the number of certificates that are waiting to be issued against Letsencrypt in the Appwrite internal queue server.
Response
200 application/json
GET /health/queue/certificates
GET /v1/health/queue/certificates HTTP/1.1
Host: HOSTNAME
Content-Type: application/json
X-Appwrite-Response-Format: 1.0.0
X-Appwrite-Project: 5df5acd0d48c2
X-Appwrite-Key: 919c2d18fb5d4...a2ae413da83346ad2
Get DB
Check the Appwrite database server is up and connection is successful.
Response
200 application/json
GET /health/db
GET /v1/health/db HTTP/1.1
Host: HOSTNAME
Content-Type: application/json
X-Appwrite-Response-Format: 1.0.0
X-Appwrite-Project: 5df5acd0d48c2
X-Appwrite-Key: 919c2d18fb5d4...a2ae413da83346ad2
Get Functions Queue
Response
200 application/json
GET /health/queue/functions
GET /v1/health/queue/functions HTTP/1.1
Host: HOSTNAME
Content-Type: application/json
X-Appwrite-Response-Format: 1.0.0
X-Appwrite-Project: 5df5acd0d48c2
X-Appwrite-Key: 919c2d18fb5d4...a2ae413da83346ad2
GET /health
GET /v1/health HTTP/1.1
Host: HOSTNAME
Content-Type: application/json
X-Appwrite-Response-Format: 1.0.0
X-Appwrite-Project: 5df5acd0d48c2
X-Appwrite-Key: 919c2d18fb5d4...a2ae413da83346ad2
Get Local Storage
Check the Appwrite local storage device is up and connection is successful.
Response
200 application/json
GET /health/storage/local
GET /v1/health/storage/local HTTP/1.1
Host: HOSTNAME
Content-Type: application/json
X-Appwrite-Response-Format: 1.0.0
X-Appwrite-Project: 5df5acd0d48c2
X-Appwrite-Key: 919c2d18fb5d4...a2ae413da83346ad2
Get Logs Queue
Get the number of logs that are waiting to be processed in the Appwrite internal queue server.
Response
200 application/json
GET /health/queue/logs
GET /v1/health/queue/logs HTTP/1.1
Host: HOSTNAME
Content-Type: application/json
X-Appwrite-Response-Format: 1.0.0
X-Appwrite-Project: 5df5acd0d48c2
X-Appwrite-Key: 919c2d18fb5d4...a2ae413da83346ad2
Get Time
Check the Appwrite server time is synced with Google remote NTP server. We use this technology to smoothly handle leap seconds with no disruptive events. The Network Time Protocol (NTP) is used by hundreds of millions of computers and devices to synchronize their clocks over the Internet. If your computer sets its own clock, it likely uses NTP.
Response
200 application/json
GET /health/time
GET /v1/health/time HTTP/1.1
Host: HOSTNAME
Content-Type: application/json
X-Appwrite-Response-Format: 1.0.0
X-Appwrite-Project: 5df5acd0d48c2
X-Appwrite-Key: 919c2d18fb5d4...a2ae413da83346ad2
Get Webhooks Queue
Get the number of webhooks that are waiting to be processed in the Appwrite internal queue server.
Response
200 application/json
GET /health/queue/webhooks
GET /v1/health/queue/webhooks HTTP/1.1
Host: HOSTNAME
Content-Type: application/json
X-Appwrite-Response-Format: 1.0.0
X-Appwrite-Project: 5df5acd0d48c2
X-Appwrite-Key: 919c2d18fb5d4...a2ae413da83346ad2