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://cloud.appwrite.io/v1
GET /health
require 'Appwrite'
include Appwrite
client = Client.new
.set_endpoint('https://[HOSTNAME_OR_IP]/v1') # Your API Endpoint
.set_project('5df5acd0d48c2') # Your project ID
.set_key('919c2d18fb5d4...a2ae413da83346ad2') # Your secret API key
health = Health.new(client)
response = health.get()
puts response.inspect
Get Antivirus
Check the Appwrite Antivirus server is up and connection is successful.
Response
200 application/json
GET /health/anti-virus
require 'Appwrite'
include Appwrite
client = Client.new
.set_endpoint('https://[HOSTNAME_OR_IP]/v1') # Your API Endpoint
.set_project('5df5acd0d48c2') # Your project ID
.set_key('919c2d18fb5d4...a2ae413da83346ad2') # Your secret API key
health = Health.new(client)
response = health.get_antivirus()
puts response.inspect
Get Cache
Check the Appwrite in-memory cache server is up and connection is successful.
Response
200 application/json
GET /health/cache
require 'Appwrite'
include Appwrite
client = Client.new
.set_endpoint('https://[HOSTNAME_OR_IP]/v1') # Your API Endpoint
.set_project('5df5acd0d48c2') # Your project ID
.set_key('919c2d18fb5d4...a2ae413da83346ad2') # Your secret API key
health = Health.new(client)
response = health.get_cache()
puts response.inspect
Get DB
Check the Appwrite database server is up and connection is successful.
Response
200 application/json
GET /health/db
require 'Appwrite'
include Appwrite
client = Client.new
.set_endpoint('https://[HOSTNAME_OR_IP]/v1') # Your API Endpoint
.set_project('5df5acd0d48c2') # Your project ID
.set_key('919c2d18fb5d4...a2ae413da83346ad2') # Your secret API key
health = Health.new(client)
response = health.get_db()
puts response.inspect
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
require 'Appwrite'
include Appwrite
client = Client.new
.set_endpoint('https://[HOSTNAME_OR_IP]/v1') # Your API Endpoint
.set_project('5df5acd0d48c2') # Your project ID
.set_key('919c2d18fb5d4...a2ae413da83346ad2') # Your secret API key
health = Health.new(client)
response = health.get_queue_certificates()
puts response.inspect
GET /health/queue/functions
require 'Appwrite'
include Appwrite
client = Client.new
.set_endpoint('https://[HOSTNAME_OR_IP]/v1') # Your API Endpoint
.set_project('5df5acd0d48c2') # Your project ID
.set_key('919c2d18fb5d4...a2ae413da83346ad2') # Your secret API key
health = Health.new(client)
response = health.get_queue_functions()
puts response.inspect
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
require 'Appwrite'
include Appwrite
client = Client.new
.set_endpoint('https://[HOSTNAME_OR_IP]/v1') # Your API Endpoint
.set_project('5df5acd0d48c2') # Your project ID
.set_key('919c2d18fb5d4...a2ae413da83346ad2') # Your secret API key
health = Health.new(client)
response = health.get_queue_logs()
puts response.inspect
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
require 'Appwrite'
include Appwrite
client = Client.new
.set_endpoint('https://[HOSTNAME_OR_IP]/v1') # Your API Endpoint
.set_project('5df5acd0d48c2') # Your project ID
.set_key('919c2d18fb5d4...a2ae413da83346ad2') # Your secret API key
health = Health.new(client)
response = health.get_queue_webhooks()
puts response.inspect
Get Local Storage
Check the Appwrite local storage device is up and connection is successful.
Response
200 application/json
GET /health/storage/local
require 'Appwrite'
include Appwrite
client = Client.new
.set_endpoint('https://[HOSTNAME_OR_IP]/v1') # Your API Endpoint
.set_project('5df5acd0d48c2') # Your project ID
.set_key('919c2d18fb5d4...a2ae413da83346ad2') # Your secret API key
health = Health.new(client)
response = health.get_storage_local()
puts response.inspect
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
require 'Appwrite'
include Appwrite
client = Client.new
.set_endpoint('https://[HOSTNAME_OR_IP]/v1') # Your API Endpoint
.set_project('5df5acd0d48c2') # Your project ID
.set_key('919c2d18fb5d4...a2ae413da83346ad2') # Your secret API key
health = Health.new(client)
response = health.get_time()
puts response.inspect