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
const sdk = require('node-appwrite');
const client = new sdk.Client()
.setEndpoint('https://cloud.appwrite.io/v1') // Your API Endpoint
.setProject('<YOUR_PROJECT_ID>') // Your project ID
.setKey('<YOUR_API_KEY>'); // Your secret API key
const health = new sdk.Health(client);
const result = await health.get();
GET /health/anti-virus
const sdk = require('node-appwrite');
const client = new sdk.Client()
.setEndpoint('https://cloud.appwrite.io/v1') // Your API Endpoint
.setProject('<YOUR_PROJECT_ID>') // Your project ID
.setKey('<YOUR_API_KEY>'); // Your secret API key
const health = new sdk.Health(client);
const result = await health.getAntivirus();
Get cache
Check the Appwrite in-memory cache servers are up and connection is successful.
Response
200
GET /health/cache
const sdk = require('node-appwrite');
const client = new sdk.Client()
.setEndpoint('https://cloud.appwrite.io/v1') // Your API Endpoint
.setProject('<YOUR_PROJECT_ID>') // Your project ID
.setKey('<YOUR_API_KEY>'); // Your secret API key
const health = new sdk.Health(client);
const result = await health.getCache();
Get the SSL certificate for a domain
Get the SSL certificate for a domain
Request
domain string
Response
GET /health/certificate
const sdk = require('node-appwrite');
const client = new sdk.Client()
.setEndpoint('https://cloud.appwrite.io/v1') // Your API Endpoint
.setProject('<YOUR_PROJECT_ID>') // Your project ID
.setKey('<YOUR_API_KEY>'); // Your secret API key
const health = new sdk.Health(client);
const result = await health.getCertificate(
'' // domain (optional)
);
GET /health/db
const sdk = require('node-appwrite');
const client = new sdk.Client()
.setEndpoint('https://cloud.appwrite.io/v1') // Your API Endpoint
.setProject('<YOUR_PROJECT_ID>') // Your project ID
.setKey('<YOUR_API_KEY>'); // Your secret API key
const health = new sdk.Health(client);
const result = await health.getDB();
GET /health/pubsub
const sdk = require('node-appwrite');
const client = new sdk.Client()
.setEndpoint('https://cloud.appwrite.io/v1') // Your API Endpoint
.setProject('<YOUR_PROJECT_ID>') // Your project ID
.setKey('<YOUR_API_KEY>'); // Your secret API key
const health = new sdk.Health(client);
const result = await health.getPubSub();
Get queue
Check the Appwrite queue messaging servers are up and connection is successful.
Response
200
GET /health/queue
const sdk = require('node-appwrite');
const client = new sdk.Client()
.setEndpoint('https://cloud.appwrite.io/v1') // Your API Endpoint
.setProject('<YOUR_PROJECT_ID>') // Your project ID
.setKey('<YOUR_API_KEY>'); // Your secret API key
const health = new sdk.Health(client);
const result = await health.getQueue();
Get builds queue
Get the number of builds that are waiting to be processed in the Appwrite internal queue server.
Request
threshold Queue size threshold. When hit (equal or higher), endpoint returns server error. Default value is 5000.
Response
200
GET /health/queue/builds
const sdk = require('node-appwrite');
const client = new sdk.Client()
.setEndpoint('https://cloud.appwrite.io/v1') // Your API Endpoint
.setProject('<YOUR_PROJECT_ID>') // Your project ID
.setKey('<YOUR_API_KEY>'); // Your secret API key
const health = new sdk.Health(client);
const result = await health.getQueueBuilds(
null // threshold (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 Queue size threshold. When hit (equal or higher), endpoint returns server error. Default value is 5000.
Response
200
GET /health/queue/certificates
const sdk = require('node-appwrite');
const client = new sdk.Client()
.setEndpoint('https://cloud.appwrite.io/v1') // Your API Endpoint
.setProject('<YOUR_PROJECT_ID>') // Your project ID
.setKey('<YOUR_API_KEY>'); // Your secret API key
const health = new sdk.Health(client);
const result = await health.getQueueCertificates(
null // threshold (optional)
);
Get databases queue
Get the number of database changes that are waiting to be processed in the Appwrite internal queue server.
Request
name Queue name for which to check the queue size
threshold Queue size threshold. When hit (equal or higher), endpoint returns server error. Default value is 5000.
Response
200
GET /health/queue/databases
const sdk = require('node-appwrite');
const client = new sdk.Client()
.setEndpoint('https://cloud.appwrite.io/v1') // Your API Endpoint
.setProject('<YOUR_PROJECT_ID>') // Your project ID
.setKey('<YOUR_API_KEY>'); // Your secret API key
const health = new sdk.Health(client);
const result = await health.getQueueDatabases(
'<NAME>', // name (optional)
null // threshold (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 Queue size threshold. When hit (equal or higher), endpoint returns server error. Default value is 5000.
Response
200
GET /health/queue/deletes
const sdk = require('node-appwrite');
const client = new sdk.Client()
.setEndpoint('https://cloud.appwrite.io/v1') // Your API Endpoint
.setProject('<YOUR_PROJECT_ID>') // Your project ID
.setKey('<YOUR_API_KEY>'); // Your secret API key
const health = new sdk.Health(client);
const result = await health.getQueueDeletes(
null // threshold (optional)
);
Get number of failed queue jobs
Returns the amount of failed jobs in a given queue.
Request
name requiredThe name of the queue
threshold Queue size threshold. When hit (equal or higher), endpoint returns server error. Default value is 5000.
Response
200
GET /health/queue/failed/{name}
const sdk = require('node-appwrite');
const client = new sdk.Client()
.setEndpoint('https://cloud.appwrite.io/v1') // Your API Endpoint
.setProject('<YOUR_PROJECT_ID>') // Your project ID
.setKey('<YOUR_API_KEY>'); // Your secret API key
const health = new sdk.Health(client);
const result = await health.getFailedJobs(
sdk..V1Database, // name
null // threshold (optional)
);
Get functions queue
Get the number of function executions that are waiting to be processed in the Appwrite internal queue server.
Request
threshold Queue size threshold. When hit (equal or higher), endpoint returns server error. Default value is 5000.
Response
200
GET /health/queue/functions
const sdk = require('node-appwrite');
const client = new sdk.Client()
.setEndpoint('https://cloud.appwrite.io/v1') // Your API Endpoint
.setProject('<YOUR_PROJECT_ID>') // Your project ID
.setKey('<YOUR_API_KEY>'); // Your secret API key
const health = new sdk.Health(client);
const result = await health.getQueueFunctions(
null // threshold (optional)
);
Get logs queue
Get the number of logs that are waiting to be processed in the Appwrite internal queue server.
Request
threshold Queue size threshold. When hit (equal or higher), endpoint returns server error. Default value is 5000.
Response
200
GET /health/queue/logs
const sdk = require('node-appwrite');
const client = new sdk.Client()
.setEndpoint('https://cloud.appwrite.io/v1') // Your API Endpoint
.setProject('<YOUR_PROJECT_ID>') // Your project ID
.setKey('<YOUR_API_KEY>'); // Your secret API key
const health = new sdk.Health(client);
const result = await health.getQueueLogs(
null // threshold (optional)
);
Get mails queue
Get the number of mails that are waiting to be processed in the Appwrite internal queue server.
Request
threshold Queue size threshold. When hit (equal or higher), endpoint returns server error. Default value is 5000.
Response
200
GET /health/queue/mails
const sdk = require('node-appwrite');
const client = new sdk.Client()
.setEndpoint('https://cloud.appwrite.io/v1') // Your API Endpoint
.setProject('<YOUR_PROJECT_ID>') // Your project ID
.setKey('<YOUR_API_KEY>'); // Your secret API key
const health = new sdk.Health(client);
const result = await health.getQueueMails(
null // threshold (optional)
);
Get messaging queue
Get the number of messages that are waiting to be processed in the Appwrite internal queue server.
Request
threshold Queue size threshold. When hit (equal or higher), endpoint returns server error. Default value is 5000.
Response
200
GET /health/queue/messaging
const sdk = require('node-appwrite');
const client = new sdk.Client()
.setEndpoint('https://cloud.appwrite.io/v1') // Your API Endpoint
.setProject('<YOUR_PROJECT_ID>') // Your project ID
.setKey('<YOUR_API_KEY>'); // Your secret API key
const health = new sdk.Health(client);
const result = await health.getQueueMessaging(
null // threshold (optional)
);
Get migrations queue
Get the number of migrations that are waiting to be processed in the Appwrite internal queue server.
Request
threshold Queue size threshold. When hit (equal or higher), endpoint returns server error. Default value is 5000.
Response
200
GET /health/queue/migrations
const sdk = require('node-appwrite');
const client = new sdk.Client()
.setEndpoint('https://cloud.appwrite.io/v1') // Your API Endpoint
.setProject('<YOUR_PROJECT_ID>') // Your project ID
.setKey('<YOUR_API_KEY>'); // Your secret API key
const health = new sdk.Health(client);
const result = await health.getQueueMigrations(
null // threshold (optional)
);
Get usage queue
Get the number of metrics that are waiting to be processed in the Appwrite internal queue server.
Request
threshold Queue size threshold. When hit (equal or higher), endpoint returns server error. Default value is 5000.
Response
200
GET /health/queue/usage
const sdk = require('node-appwrite');
const client = new sdk.Client()
.setEndpoint('https://cloud.appwrite.io/v1') // Your API Endpoint
.setProject('<YOUR_PROJECT_ID>') // Your project ID
.setKey('<YOUR_API_KEY>'); // Your secret API key
const health = new sdk.Health(client);
const result = await health.getQueueUsage(
null // threshold (optional)
);
Get usage dump queue
Get the number of projects containing metrics that are waiting to be processed in the Appwrite internal queue server.
Request
threshold Queue size threshold. When hit (equal or higher), endpoint returns server error. Default value is 5000.
Response
200
GET /health/queue/usage-dump
const sdk = require('node-appwrite');
const client = new sdk.Client()
.setEndpoint('https://cloud.appwrite.io/v1') // Your API Endpoint
.setProject('<YOUR_PROJECT_ID>') // Your project ID
.setKey('<YOUR_API_KEY>'); // Your secret API key
const health = new sdk.Health(client);
const result = await health.getQueueUsageDump(
null // threshold (optional)
);
Get webhooks queue
Get the number of webhooks that are waiting to be processed in the Appwrite internal queue server.
Request
threshold Queue size threshold. When hit (equal or higher), endpoint returns server error. Default value is 5000.
Response
200
GET /health/queue/webhooks
const sdk = require('node-appwrite');
const client = new sdk.Client()
.setEndpoint('https://cloud.appwrite.io/v1') // Your API Endpoint
.setProject('<YOUR_PROJECT_ID>') // Your project ID
.setKey('<YOUR_API_KEY>'); // Your secret API key
const health = new sdk.Health(client);
const result = await health.getQueueWebhooks(
null // threshold (optional)
);
GET /health/storage
const sdk = require('node-appwrite');
const client = new sdk.Client()
.setEndpoint('https://cloud.appwrite.io/v1') // Your API Endpoint
.setProject('<YOUR_PROJECT_ID>') // Your project ID
.setKey('<YOUR_API_KEY>'); // Your secret API key
const health = new sdk.Health(client);
const result = await health.getStorage();
Get local storage
Check the Appwrite local storage device is up and connection is successful.
Response
200
GET /health/storage/local
const sdk = require('node-appwrite');
const client = new sdk.Client()
.setEndpoint('https://cloud.appwrite.io/v1') // Your API Endpoint
.setProject('<YOUR_PROJECT_ID>') // Your project ID
.setKey('<YOUR_API_KEY>'); // Your secret API key
const health = new sdk.Health(client);
const result = await health.getStorageLocal();
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
GET /health/time
const sdk = require('node-appwrite');
const client = new sdk.Client()
.setEndpoint('https://cloud.appwrite.io/v1') // Your API Endpoint
.setProject('<YOUR_PROJECT_ID>') // Your project ID
.setKey('<YOUR_API_KEY>'); // Your secret API key
const health = new sdk.Health(client);
const result = await health.getTime();