Health

SERVER

Platform

Version

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.

Base URL

https://<REGION>.cloud.appwrite.io/v1

Get antivirus

Check the Appwrite Antivirus server is up and connection is successful.

Response
- 200 application/json
  
  Health Antivirus

Endpoint

GET /health/anti-virus

Java

import io.appwrite.Client;
import io.appwrite.coroutines.CoroutineCallback;
import io.appwrite.services.Health;

Client client = new Client()
    .setEndpoint("https://<REGION>.cloud.appwrite.io/v1") // Your API Endpoint
    .setProject("<YOUR_PROJECT_ID>") // Your project ID
    .setKey("<YOUR_API_KEY>"); // Your secret API key

Health health = new Health(client);

health.getAntivirus(new CoroutineCallback<>((result, error) -> {
    if (error != null) {
        error.printStackTrace();
        return;
    }

    System.out.println(result);
}));

Get cache

Check the Appwrite in-memory cache servers are up and connection is successful.

Response
- 200 application/json
  
  Health Status

Endpoint

GET /health/cache

Java

import io.appwrite.Client;
import io.appwrite.coroutines.CoroutineCallback;
import io.appwrite.services.Health;

Client client = new Client()
    .setEndpoint("https://<REGION>.cloud.appwrite.io/v1") // Your API Endpoint
    .setProject("<YOUR_PROJECT_ID>") // Your project ID
    .setKey("<YOUR_API_KEY>"); // Your secret API key

Health health = new Health(client);

health.getCache(new CoroutineCallback<>((result, error) -> {
    if (error != null) {
        error.printStackTrace();
        return;
    }

    System.out.println(result);
}));

Get DB

Check the Appwrite database servers are up and connection is successful.

Response
- 200 application/json
  
  Health Status

Endpoint

GET /health/db

Java

import io.appwrite.Client;
import io.appwrite.coroutines.CoroutineCallback;
import io.appwrite.services.Health;

Client client = new Client()
    .setEndpoint("https://<REGION>.cloud.appwrite.io/v1") // Your API Endpoint
    .setProject("<YOUR_PROJECT_ID>") // Your project ID
    .setKey("<YOUR_API_KEY>"); // Your secret API key

Health health = new Health(client);

health.getDB(new CoroutineCallback<>((result, error) -> {
    if (error != null) {
        error.printStackTrace();
        return;
    }

    System.out.println(result);
}));

Get HTTP

Check the Appwrite HTTP server is up and responsive.

Response
- 200 application/json
  
  Health Status

Endpoint

GET /health

Java

import io.appwrite.Client;
import io.appwrite.coroutines.CoroutineCallback;
import io.appwrite.services.Health;

Client client = new Client()
    .setEndpoint("https://<REGION>.cloud.appwrite.io/v1") // Your API Endpoint
    .setProject("<YOUR_PROJECT_ID>") // Your project ID
    .setKey("<YOUR_API_KEY>"); // Your secret API key

Health health = new Health(client);

health.get(new CoroutineCallback<>((result, error) -> {
    if (error != null) {
        error.printStackTrace();
        return;
    }

    System.out.println(result);
}));

Get pubsub

Check the Appwrite pub-sub servers are up and connection is successful.

Response
- 200 application/json
  
  Health Status

Endpoint

GET /health/pubsub

Java

import io.appwrite.Client;
import io.appwrite.coroutines.CoroutineCallback;
import io.appwrite.services.Health;

Client client = new Client()
    .setEndpoint("https://<REGION>.cloud.appwrite.io/v1") // Your API Endpoint
    .setProject("<YOUR_PROJECT_ID>") // Your project ID
    .setKey("<YOUR_API_KEY>"); // Your secret API key

Health health = new Health(client);

health.getPubSub(new CoroutineCallback<>((result, error) -> {
    if (error != null) {
        error.printStackTrace();
        return;
    }

    System.out.println(result);
}));

Get the SSL certificate for a domain

Request
- domain string
  
  string
Response
- 200 application/json
  
  Health Certificate

Endpoint

GET /health/certificate

Java

import io.appwrite.Client;
import io.appwrite.coroutines.CoroutineCallback;
import io.appwrite.services.Health;

Client client = new Client()
    .setEndpoint("https://<REGION>.cloud.appwrite.io/v1") // Your API Endpoint
    .setProject("<YOUR_PROJECT_ID>") // Your project ID
    .setKey("<YOUR_API_KEY>"); // Your secret API key

Health health = new Health(client);

health.getCertificate(
    "", // domain (optional)
    new CoroutineCallback<>((result, error) -> {
        if (error != null) {
            error.printStackTrace();
            return;
        }

        System.out.println(result);
    })
);

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
  
  Health Time

Endpoint

GET /health/time

Java

import io.appwrite.Client;
import io.appwrite.coroutines.CoroutineCallback;
import io.appwrite.services.Health;

Client client = new Client()
    .setEndpoint("https://<REGION>.cloud.appwrite.io/v1") // Your API Endpoint
    .setProject("<YOUR_PROJECT_ID>") // Your project ID
    .setKey("<YOUR_API_KEY>"); // Your secret API key

Health health = new Health(client);

health.getTime(new CoroutineCallback<>((result, error) -> {
    if (error != null) {
        error.printStackTrace();
        return;
    }

    System.out.println(result);
}));

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
  
  Health Queue

Endpoint

GET /health/queue/builds

Java

import io.appwrite.Client;
import io.appwrite.coroutines.CoroutineCallback;
import io.appwrite.services.Health;

Client client = new Client()
    .setEndpoint("https://<REGION>.cloud.appwrite.io/v1") // Your API Endpoint
    .setProject("<YOUR_PROJECT_ID>") // Your project ID
    .setKey("<YOUR_API_KEY>"); // Your secret API key

Health health = new Health(client);

health.getQueueBuilds(
    0, // threshold (optional)
    new CoroutineCallback<>((result, error) -> {
        if (error != null) {
            error.printStackTrace();
            return;
        }

        System.out.println(result);
    })
);

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
  
  Health Queue

Endpoint

GET /health/queue/certificates

Java

import io.appwrite.Client;
import io.appwrite.coroutines.CoroutineCallback;
import io.appwrite.services.Health;

Client client = new Client()
    .setEndpoint("https://<REGION>.cloud.appwrite.io/v1") // Your API Endpoint
    .setProject("<YOUR_PROJECT_ID>") // Your project ID
    .setKey("<YOUR_API_KEY>"); // Your secret API key

Health health = new Health(client);

health.getQueueCertificates(
    0, // threshold (optional)
    new CoroutineCallback<>((result, error) -> {
        if (error != null) {
            error.printStackTrace();
            return;
        }

        System.out.println(result);
    })
);

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
  
  Health Queue

Endpoint

GET /health/queue/databases

Java

import io.appwrite.Client;
import io.appwrite.coroutines.CoroutineCallback;
import io.appwrite.services.Health;

Client client = new Client()
    .setEndpoint("https://<REGION>.cloud.appwrite.io/v1") // Your API Endpoint
    .setProject("<YOUR_PROJECT_ID>") // Your project ID
    .setKey("<YOUR_API_KEY>"); // Your secret API key

Health health = new Health(client);

health.getQueueDatabases(
    "<NAME>", // name (optional)
    0, // threshold (optional)
    new CoroutineCallback<>((result, error) -> {
        if (error != null) {
            error.printStackTrace();
            return;
        }

        System.out.println(result);
    })
);

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
  
  Health Queue

Endpoint

GET /health/queue/deletes

Java

import io.appwrite.Client;
import io.appwrite.coroutines.CoroutineCallback;
import io.appwrite.services.Health;

Client client = new Client()
    .setEndpoint("https://<REGION>.cloud.appwrite.io/v1") // Your API Endpoint
    .setProject("<YOUR_PROJECT_ID>") // Your project ID
    .setKey("<YOUR_API_KEY>"); // Your secret API key

Health health = new Health(client);

health.getQueueDeletes(
    0, // threshold (optional)
    new CoroutineCallback<>((result, error) -> {
        if (error != null) {
            error.printStackTrace();
            return;
        }

        System.out.println(result);
    })
);

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
  
  Health Queue

Endpoint

GET /health/queue/functions

Java

import io.appwrite.Client;
import io.appwrite.coroutines.CoroutineCallback;
import io.appwrite.services.Health;

Client client = new Client()
    .setEndpoint("https://<REGION>.cloud.appwrite.io/v1") // Your API Endpoint
    .setProject("<YOUR_PROJECT_ID>") // Your project ID
    .setKey("<YOUR_API_KEY>"); // Your secret API key

Health health = new Health(client);

health.getQueueFunctions(
    0, // threshold (optional)
    new CoroutineCallback<>((result, error) -> {
        if (error != null) {
            error.printStackTrace();
            return;
        }

        System.out.println(result);
    })
);

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
  
  Health Queue

Endpoint

GET /health/queue/logs

Java

import io.appwrite.Client;
import io.appwrite.coroutines.CoroutineCallback;
import io.appwrite.services.Health;

Client client = new Client()
    .setEndpoint("https://<REGION>.cloud.appwrite.io/v1") // Your API Endpoint
    .setProject("<YOUR_PROJECT_ID>") // Your project ID
    .setKey("<YOUR_API_KEY>"); // Your secret API key

Health health = new Health(client);

health.getQueueLogs(
    0, // threshold (optional)
    new CoroutineCallback<>((result, error) -> {
        if (error != null) {
            error.printStackTrace();
            return;
        }

        System.out.println(result);
    })
);

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
  
  Health Queue

Endpoint

GET /health/queue/mails

Java

import io.appwrite.Client;
import io.appwrite.coroutines.CoroutineCallback;
import io.appwrite.services.Health;

Client client = new Client()
    .setEndpoint("https://<REGION>.cloud.appwrite.io/v1") // Your API Endpoint
    .setProject("<YOUR_PROJECT_ID>") // Your project ID
    .setKey("<YOUR_API_KEY>"); // Your secret API key

Health health = new Health(client);

health.getQueueMails(
    0, // threshold (optional)
    new CoroutineCallback<>((result, error) -> {
        if (error != null) {
            error.printStackTrace();
            return;
        }

        System.out.println(result);
    })
);

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
  
  Health Queue

Endpoint

GET /health/queue/messaging

Java

import io.appwrite.Client;
import io.appwrite.coroutines.CoroutineCallback;
import io.appwrite.services.Health;

Client client = new Client()
    .setEndpoint("https://<REGION>.cloud.appwrite.io/v1") // Your API Endpoint
    .setProject("<YOUR_PROJECT_ID>") // Your project ID
    .setKey("<YOUR_API_KEY>"); // Your secret API key

Health health = new Health(client);

health.getQueueMessaging(
    0, // threshold (optional)
    new CoroutineCallback<>((result, error) -> {
        if (error != null) {
            error.printStackTrace();
            return;
        }

        System.out.println(result);
    })
);

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
  
  Health Queue

Endpoint

GET /health/queue/migrations

Java

import io.appwrite.Client;
import io.appwrite.coroutines.CoroutineCallback;
import io.appwrite.services.Health;

Client client = new Client()
    .setEndpoint("https://<REGION>.cloud.appwrite.io/v1") // Your API Endpoint
    .setProject("<YOUR_PROJECT_ID>") // Your project ID
    .setKey("<YOUR_API_KEY>"); // Your secret API key

Health health = new Health(client);

health.getQueueMigrations(
    0, // threshold (optional)
    new CoroutineCallback<>((result, error) -> {
        if (error != null) {
            error.printStackTrace();
            return;
        }

        System.out.println(result);
    })
);

Get number of failed queue jobs

Returns the amount of failed jobs in a given queue.

Request
- name string
  required
  
  The 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
  
  Health Queue

Endpoint

GET /health/queue/failed/{name}

Java

import io.appwrite.Client;
import io.appwrite.coroutines.CoroutineCallback;
import io.appwrite.services.Health;
import io.appwrite.enums.Name;

Client client = new Client()
    .setEndpoint("https://<REGION>.cloud.appwrite.io/v1") // Your API Endpoint
    .setProject("<YOUR_PROJECT_ID>") // Your project ID
    .setKey("<YOUR_API_KEY>"); // Your secret API key

Health health = new Health(client);

health.getFailedJobs(
    .V1_DATABASE, // name
    0, // threshold (optional)
    new CoroutineCallback<>((result, error) -> {
        if (error != null) {
            error.printStackTrace();
            return;
        }

        System.out.println(result);
    })
);

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
  
  Health Queue

Endpoint

GET /health/queue/stats-resources

Java

import io.appwrite.Client;
import io.appwrite.coroutines.CoroutineCallback;
import io.appwrite.services.Health;

Client client = new Client()
    .setEndpoint("https://<REGION>.cloud.appwrite.io/v1") // Your API Endpoint
    .setProject("<YOUR_PROJECT_ID>") // Your project ID
    .setKey("<YOUR_API_KEY>"); // Your secret API key

Health health = new Health(client);

health.getQueueStatsResources(
    0, // threshold (optional)
    new CoroutineCallback<>((result, error) -> {
        if (error != null) {
            error.printStackTrace();
            return;
        }

        System.out.println(result);
    })
);

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
  
  Health Queue

Endpoint

GET /health/queue/stats-usage

Java

import io.appwrite.Client;
import io.appwrite.coroutines.CoroutineCallback;
import io.appwrite.services.Health;

Client client = new Client()
    .setEndpoint("https://<REGION>.cloud.appwrite.io/v1") // Your API Endpoint
    .setProject("<YOUR_PROJECT_ID>") // Your project ID
    .setKey("<YOUR_API_KEY>"); // Your secret API key

Health health = new Health(client);

health.getQueueUsage(
    0, // threshold (optional)
    new CoroutineCallback<>((result, error) -> {
        if (error != null) {
            error.printStackTrace();
            return;
        }

        System.out.println(result);
    })
);

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
  
  Health Queue

Endpoint

GET /health/queue/webhooks

Java

import io.appwrite.Client;
import io.appwrite.coroutines.CoroutineCallback;
import io.appwrite.services.Health;

Client client = new Client()
    .setEndpoint("https://<REGION>.cloud.appwrite.io/v1") // Your API Endpoint
    .setProject("<YOUR_PROJECT_ID>") // Your project ID
    .setKey("<YOUR_API_KEY>"); // Your secret API key

Health health = new Health(client);

health.getQueueWebhooks(
    0, // threshold (optional)
    new CoroutineCallback<>((result, error) -> {
        if (error != null) {
            error.printStackTrace();
            return;
        }

        System.out.println(result);
    })
);

Get local storage

Check the Appwrite local storage device is up and connection is successful.

Response
- 200 application/json
  
  Health Status

Endpoint

GET /health/storage/local

Java

import io.appwrite.Client;
import io.appwrite.coroutines.CoroutineCallback;
import io.appwrite.services.Health;

Client client = new Client()
    .setEndpoint("https://<REGION>.cloud.appwrite.io/v1") // Your API Endpoint
    .setProject("<YOUR_PROJECT_ID>") // Your project ID
    .setKey("<YOUR_API_KEY>"); // Your secret API key

Health health = new Health(client);

health.getStorageLocal(new CoroutineCallback<>((result, error) -> {
    if (error != null) {
        error.printStackTrace();
        return;
    }

    System.out.println(result);
}));

Get storage

Check the Appwrite storage device is up and connection is successful.

Response
- 200 application/json
  
  Health Status

Endpoint

GET /health/storage

Java

import io.appwrite.Client;
import io.appwrite.coroutines.CoroutineCallback;
import io.appwrite.services.Health;

Client client = new Client()
    .setEndpoint("https://<REGION>.cloud.appwrite.io/v1") // Your API Endpoint
    .setProject("<YOUR_PROJECT_ID>") // Your project ID
    .setKey("<YOUR_API_KEY>"); // Your secret API key

Health health = new Health(client);

health.getStorage(new CoroutineCallback<>((result, error) -> {
    if (error != null) {
        error.printStackTrace();
        return;
    }

    System.out.println(result);
}));

Health

Get antivirus

Get cache

Get DB

Get HTTP

Get pubsub

Get the SSL certificate for a domain

Get time

Get builds queue

Get certificates queue

Get databases queue

Get deletes queue

Get functions queue

Get logs queue

Get mails queue

Get messaging queue

Get migrations queue

Get number of failed queue jobs

Get stats resources queue

Get stats usage queue

Get webhooks queue

Get local storage

Get storage

Recommended