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
from appwrite.client import Client
from appwrite.services.health import Health
client = Client()
client.set_endpoint('https://<REGION>.cloud.appwrite.io/v1') # Your API Endpoint
client.set_project('<YOUR_PROJECT_ID>') # Your project ID
client.set_key('<YOUR_API_KEY>') # Your secret API key
health = Health(client)
result = health.get_antivirus()
Get cache
Check the Appwrite in-memory cache servers are up and connection is successful.
Response
200 application/json
GET /health/cache
from appwrite.client import Client
from appwrite.services.health import Health
client = Client()
client.set_endpoint('https://<REGION>.cloud.appwrite.io/v1') # Your API Endpoint
client.set_project('<YOUR_PROJECT_ID>') # Your project ID
client.set_key('<YOUR_API_KEY>') # Your secret API key
health = Health(client)
result = health.get_cache()
Get DB
Check the Appwrite database servers are up and connection is successful.
Response
200 application/json
GET /health/db
from appwrite.client import Client
from appwrite.services.health import Health
client = Client()
client.set_endpoint('https://<REGION>.cloud.appwrite.io/v1') # Your API Endpoint
client.set_project('<YOUR_PROJECT_ID>') # Your project ID
client.set_key('<YOUR_API_KEY>') # Your secret API key
health = Health(client)
result = health.get_db()
GET /health
from appwrite.client import Client
from appwrite.services.health import Health
client = Client()
client.set_endpoint('https://<REGION>.cloud.appwrite.io/v1') # Your API Endpoint
client.set_project('<YOUR_PROJECT_ID>') # Your project ID
client.set_key('<YOUR_API_KEY>') # Your secret API key
health = Health(client)
result = health.get()
Get pubsub
Check the Appwrite pub-sub servers are up and connection is successful.
Response
200 application/json
GET /health/pubsub
from appwrite.client import Client
from appwrite.services.health import Health
client = Client()
client.set_endpoint('https://<REGION>.cloud.appwrite.io/v1') # Your API Endpoint
client.set_project('<YOUR_PROJECT_ID>') # Your project ID
client.set_key('<YOUR_API_KEY>') # Your secret API key
health = Health(client)
result = health.get_pub_sub()
Get the SSL certificate for a domain
Get the SSL certificate for a domain
Request
domain string string
Response
200 application/json
GET /health/certificate
from appwrite.client import Client
from appwrite.services.health import Health
client = Client()
client.set_endpoint('https://<REGION>.cloud.appwrite.io/v1') # Your API Endpoint
client.set_project('<YOUR_PROJECT_ID>') # Your project ID
client.set_key('<YOUR_API_KEY>') # Your secret API key
health = Health(client)
result = health.get_certificate(
domain = '' # optional
)
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
from appwrite.client import Client
from appwrite.services.health import Health
client = Client()
client.set_endpoint('https://<REGION>.cloud.appwrite.io/v1') # Your API Endpoint
client.set_project('<YOUR_PROJECT_ID>') # Your project ID
client.set_key('<YOUR_API_KEY>') # Your secret API key
health = Health(client)
result = health.get_time()
Get builds queue
Get the number of builds that are waiting to be processed in the Appwrite internal queue server.
Request
threshold integer Queue size threshold. When hit (equal or higher), endpoint returns server error. Default value is 5000.
Response
200 application/json
GET /health/queue/builds
from appwrite.client import Client
from appwrite.services.health import Health
client = Client()
client.set_endpoint('https://<REGION>.cloud.appwrite.io/v1') # Your API Endpoint
client.set_project('<YOUR_PROJECT_ID>') # Your project ID
client.set_key('<YOUR_API_KEY>') # Your secret API key
health = Health(client)
result = health.get_queue_builds(
threshold = None # optional
)
Get certificates queue
Get the number of certificates that are waiting to be issued against Letsencrypt in the Appwrite internal queue server.
Request
threshold integer Queue size threshold. When hit (equal or higher), endpoint returns server error. Default value is 5000.
Response
200 application/json
GET /health/queue/certificates
from appwrite.client import Client
from appwrite.services.health import Health
client = Client()
client.set_endpoint('https://<REGION>.cloud.appwrite.io/v1') # Your API Endpoint
client.set_project('<YOUR_PROJECT_ID>') # Your project ID
client.set_key('<YOUR_API_KEY>') # Your secret API key
health = Health(client)
result = health.get_queue_certificates(
threshold = None # optional
)
Get databases queue
Get the number of database changes that are waiting to be processed in the Appwrite internal queue server.
Request
name string Queue name for which to check the queue size
threshold integer Queue size threshold. When hit (equal or higher), endpoint returns server error. Default value is 5000.
Response
200 application/json
GET /health/queue/databases
from appwrite.client import Client
from appwrite.services.health import Health
client = Client()
client.set_endpoint('https://<REGION>.cloud.appwrite.io/v1') # Your API Endpoint
client.set_project('<YOUR_PROJECT_ID>') # Your project ID
client.set_key('<YOUR_API_KEY>') # Your secret API key
health = Health(client)
result = health.get_queue_databases(
name = '<NAME>', # optional
threshold = None # optional
)
Get deletes queue
Get the number of background destructive changes that are waiting to be processed in the Appwrite internal queue server.
Request
threshold integer Queue size threshold. When hit (equal or higher), endpoint returns server error. Default value is 5000.
Response
200 application/json
GET /health/queue/deletes
from appwrite.client import Client
from appwrite.services.health import Health
client = Client()
client.set_endpoint('https://<REGION>.cloud.appwrite.io/v1') # Your API Endpoint
client.set_project('<YOUR_PROJECT_ID>') # Your project ID
client.set_key('<YOUR_API_KEY>') # Your secret API key
health = Health(client)
result = health.get_queue_deletes(
threshold = None # optional
)
Get functions queue
Get the number of function executions that are waiting to be processed in the Appwrite internal queue server.
Request
threshold integer Queue size threshold. When hit (equal or higher), endpoint returns server error. Default value is 5000.
Response
200 application/json
GET /health/queue/functions
from appwrite.client import Client
from appwrite.services.health import Health
client = Client()
client.set_endpoint('https://<REGION>.cloud.appwrite.io/v1') # Your API Endpoint
client.set_project('<YOUR_PROJECT_ID>') # Your project ID
client.set_key('<YOUR_API_KEY>') # Your secret API key
health = Health(client)
result = health.get_queue_functions(
threshold = None # optional
)
Get logs queue
Get the number of logs that are waiting to be processed in the Appwrite internal queue server.
Request
threshold integer Queue size threshold. When hit (equal or higher), endpoint returns server error. Default value is 5000.
Response
200 application/json
GET /health/queue/logs
from appwrite.client import Client
from appwrite.services.health import Health
client = Client()
client.set_endpoint('https://<REGION>.cloud.appwrite.io/v1') # Your API Endpoint
client.set_project('<YOUR_PROJECT_ID>') # Your project ID
client.set_key('<YOUR_API_KEY>') # Your secret API key
health = Health(client)
result = health.get_queue_logs(
threshold = None # optional
)
Get mails queue
Get the number of mails that are waiting to be processed in the Appwrite internal queue server.
Request
threshold integer Queue size threshold. When hit (equal or higher), endpoint returns server error. Default value is 5000.
Response
200 application/json
GET /health/queue/mails
from appwrite.client import Client
from appwrite.services.health import Health
client = Client()
client.set_endpoint('https://<REGION>.cloud.appwrite.io/v1') # Your API Endpoint
client.set_project('<YOUR_PROJECT_ID>') # Your project ID
client.set_key('<YOUR_API_KEY>') # Your secret API key
health = Health(client)
result = health.get_queue_mails(
threshold = None # optional
)
Get messaging queue
Get the number of messages that are waiting to be processed in the Appwrite internal queue server.
Request
threshold integer Queue size threshold. When hit (equal or higher), endpoint returns server error. Default value is 5000.
Response
200 application/json
GET /health/queue/messaging
from appwrite.client import Client
from appwrite.services.health import Health
client = Client()
client.set_endpoint('https://<REGION>.cloud.appwrite.io/v1') # Your API Endpoint
client.set_project('<YOUR_PROJECT_ID>') # Your project ID
client.set_key('<YOUR_API_KEY>') # Your secret API key
health = Health(client)
result = health.get_queue_messaging(
threshold = None # optional
)
Get migrations queue
Get the number of migrations that are waiting to be processed in the Appwrite internal queue server.
Request
threshold integer Queue size threshold. When hit (equal or higher), endpoint returns server error. Default value is 5000.
Response
200 application/json
GET /health/queue/migrations
from appwrite.client import Client
from appwrite.services.health import Health
client = Client()
client.set_endpoint('https://<REGION>.cloud.appwrite.io/v1') # Your API Endpoint
client.set_project('<YOUR_PROJECT_ID>') # Your project ID
client.set_key('<YOUR_API_KEY>') # Your secret API key
health = Health(client)
result = health.get_queue_migrations(
threshold = None # optional
)
Get number of failed queue jobs
Returns the amount of failed jobs in a given queue.
Request
name string requiredThe name of the queue
threshold integer Queue size threshold. When hit (equal or higher), endpoint returns server error. Default value is 5000.
Response
200 application/json
GET /health/queue/failed/{name}
from appwrite.client import Client
from appwrite.services.health import Health
from appwrite.enums import
client = Client()
client.set_endpoint('https://<REGION>.cloud.appwrite.io/v1') # Your API Endpoint
client.set_project('<YOUR_PROJECT_ID>') # Your project ID
client.set_key('<YOUR_API_KEY>') # Your secret API key
health = Health(client)
result = health.get_failed_jobs(
name = .V1_DATABASE,
threshold = None # optional
)
Get stats resources queue
Get the number of metrics that are waiting to be processed in the Appwrite stats resources queue.
Request
threshold integer Queue size threshold. When hit (equal or higher), endpoint returns server error. Default value is 5000.
Response
200 application/json
GET /health/queue/stats-resources
from appwrite.client import Client
from appwrite.services.health import Health
client = Client()
client.set_endpoint('https://<REGION>.cloud.appwrite.io/v1') # Your API Endpoint
client.set_project('<YOUR_PROJECT_ID>') # Your project ID
client.set_key('<YOUR_API_KEY>') # Your secret API key
health = Health(client)
result = health.get_queue_stats_resources(
threshold = None # optional
)
Get stats usage queue
Get the number of metrics that are waiting to be processed in the Appwrite internal queue server.
Request
threshold integer Queue size threshold. When hit (equal or higher), endpoint returns server error. Default value is 5000.
Response
200 application/json
GET /health/queue/stats-usage
from appwrite.client import Client
from appwrite.services.health import Health
client = Client()
client.set_endpoint('https://<REGION>.cloud.appwrite.io/v1') # Your API Endpoint
client.set_project('<YOUR_PROJECT_ID>') # Your project ID
client.set_key('<YOUR_API_KEY>') # Your secret API key
health = Health(client)
result = health.get_queue_usage(
threshold = None # optional
)
Get webhooks queue
Get the number of webhooks that are waiting to be processed in the Appwrite internal queue server.
Request
threshold integer Queue size threshold. When hit (equal or higher), endpoint returns server error. Default value is 5000.
Response
200 application/json
GET /health/queue/webhooks
from appwrite.client import Client
from appwrite.services.health import Health
client = Client()
client.set_endpoint('https://<REGION>.cloud.appwrite.io/v1') # Your API Endpoint
client.set_project('<YOUR_PROJECT_ID>') # Your project ID
client.set_key('<YOUR_API_KEY>') # Your secret API key
health = Health(client)
result = health.get_queue_webhooks(
threshold = None # optional
)
Get local storage
Check the Appwrite local storage device is up and connection is successful.
Response
200 application/json
GET /health/storage/local
from appwrite.client import Client
from appwrite.services.health import Health
client = Client()
client.set_endpoint('https://<REGION>.cloud.appwrite.io/v1') # Your API Endpoint
client.set_project('<YOUR_PROJECT_ID>') # Your project ID
client.set_key('<YOUR_API_KEY>') # Your secret API key
health = Health(client)
result = health.get_storage_local()
Get storage
Check the Appwrite storage device is up and connection is successful.
Response
200 application/json
GET /health/storage
from appwrite.client import Client
from appwrite.services.health import Health
client = Client()
client.set_endpoint('https://<REGION>.cloud.appwrite.io/v1') # Your API Endpoint
client.set_project('<YOUR_PROJECT_ID>') # Your project ID
client.set_key('<YOUR_API_KEY>') # Your secret API key
health = Health(client)
result = health.get_storage()