Go to Console
Star on GitHub 45.1K Get started

Health

SERVER

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://cloud.appwrite.io/v1

Get HTTP

Check the Appwrite HTTP server is up and responsive.

Endpoint
GET /health
Kotlin
import io.appwrite.Client
import io.appwrite.coroutines.CoroutineCallback
import io.appwrite.services.Health

val client = 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

val health = Health(client)

val response = health.get()

Get antivirus

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

Endpoint
GET /health/anti-virus
Kotlin
import io.appwrite.Client
import io.appwrite.coroutines.CoroutineCallback
import io.appwrite.services.Health

val client = 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

val health = Health(client)

val response = health.getAntivirus()

Get cache

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

Endpoint
GET /health/cache
Kotlin
import io.appwrite.Client
import io.appwrite.coroutines.CoroutineCallback
import io.appwrite.services.Health

val client = 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

val health = Health(client)

val response = health.getCache()

Get the SSL certificate for a domain

Get the SSL certificate for a domain

Endpoint
GET /health/certificate
Kotlin
import io.appwrite.Client
import io.appwrite.coroutines.CoroutineCallback
import io.appwrite.services.Health

val client = 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

val health = Health(client)

val response = health.getCertificate(
    domain = "" // optional
)

Get DB

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

Endpoint
GET /health/db
Kotlin
import io.appwrite.Client
import io.appwrite.coroutines.CoroutineCallback
import io.appwrite.services.Health

val client = 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

val health = Health(client)

val response = health.getDB()

Get pubsub

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

Endpoint
GET /health/pubsub
Kotlin
import io.appwrite.Client
import io.appwrite.coroutines.CoroutineCallback
import io.appwrite.services.Health

val client = 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

val health = Health(client)

val response = health.getPubSub()

Get queue

Check the Appwrite queue messaging servers are up and connection is successful.

Endpoint
GET /health/queue
Kotlin
import io.appwrite.Client
import io.appwrite.coroutines.CoroutineCallback
import io.appwrite.services.Health

val client = 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

val health = Health(client)

val response = health.getQueue()

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
Endpoint
GET /health/queue/builds
Kotlin
import io.appwrite.Client
import io.appwrite.coroutines.CoroutineCallback
import io.appwrite.services.Health

val client = 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

val health = Health(client)

val response = health.getQueueBuilds(
    threshold = 0 // 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
Endpoint
GET /health/queue/certificates
Kotlin
import io.appwrite.Client
import io.appwrite.coroutines.CoroutineCallback
import io.appwrite.services.Health

val client = 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

val health = Health(client)

val response = health.getQueueCertificates(
    threshold = 0 // 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
Endpoint
GET /health/queue/databases
Kotlin
import io.appwrite.Client
import io.appwrite.coroutines.CoroutineCallback
import io.appwrite.services.Health

val client = 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

val health = Health(client)

val response = health.getQueueDatabases(
    name = "<NAME>", // optional
    threshold = 0 // 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
Endpoint
GET /health/queue/deletes
Kotlin
import io.appwrite.Client
import io.appwrite.coroutines.CoroutineCallback
import io.appwrite.services.Health

val client = 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

val health = Health(client)

val response = health.getQueueDeletes(
    threshold = 0 // optional
)

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
Endpoint
GET /health/queue/failed/{name}
Kotlin
import io.appwrite.Client
import io.appwrite.coroutines.CoroutineCallback
import io.appwrite.services.Health
import io.appwrite.enums.Name

val client = 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

val health = Health(client)

val response = health.getFailedJobs(
    name =  .V1_DATABASE,
    threshold = 0 // 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
Endpoint
GET /health/queue/functions
Kotlin
import io.appwrite.Client
import io.appwrite.coroutines.CoroutineCallback
import io.appwrite.services.Health

val client = 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

val health = Health(client)

val response = health.getQueueFunctions(
    threshold = 0 // 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
Endpoint
GET /health/queue/logs
Kotlin
import io.appwrite.Client
import io.appwrite.coroutines.CoroutineCallback
import io.appwrite.services.Health

val client = 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

val health = Health(client)

val response = health.getQueueLogs(
    threshold = 0 // 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
Endpoint
GET /health/queue/mails
Kotlin
import io.appwrite.Client
import io.appwrite.coroutines.CoroutineCallback
import io.appwrite.services.Health

val client = 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

val health = Health(client)

val response = health.getQueueMails(
    threshold = 0 // 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
Endpoint
GET /health/queue/messaging
Kotlin
import io.appwrite.Client
import io.appwrite.coroutines.CoroutineCallback
import io.appwrite.services.Health

val client = 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

val health = Health(client)

val response = health.getQueueMessaging(
    threshold = 0 // 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
Endpoint
GET /health/queue/migrations
Kotlin
import io.appwrite.Client
import io.appwrite.coroutines.CoroutineCallback
import io.appwrite.services.Health

val client = 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

val health = Health(client)

val response = health.getQueueMigrations(
    threshold = 0 // optional
)

Get 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
Endpoint
GET /health/queue/usage
Kotlin
import io.appwrite.Client
import io.appwrite.coroutines.CoroutineCallback
import io.appwrite.services.Health

val client = 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

val health = Health(client)

val response = health.getQueueUsage(
    threshold = 0 // 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 integer

      Queue size threshold. When hit (equal or higher), endpoint returns server error. Default value is 5000.

  • Response
Endpoint
GET /health/queue/usage-dump
Kotlin
import io.appwrite.Client
import io.appwrite.coroutines.CoroutineCallback
import io.appwrite.services.Health

val client = 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

val health = Health(client)

val response = health.getQueueUsageDump(
    threshold = 0 // 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
Endpoint
GET /health/queue/webhooks
Kotlin
import io.appwrite.Client
import io.appwrite.coroutines.CoroutineCallback
import io.appwrite.services.Health

val client = 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

val health = Health(client)

val response = health.getQueueWebhooks(
    threshold = 0 // optional
)

Get storage

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

Endpoint
GET /health/storage
Kotlin
import io.appwrite.Client
import io.appwrite.coroutines.CoroutineCallback
import io.appwrite.services.Health

val client = 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

val health = Health(client)

val response = health.getStorage()

Get local storage

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

Endpoint
GET /health/storage/local
Kotlin
import io.appwrite.Client
import io.appwrite.coroutines.CoroutineCallback
import io.appwrite.services.Health

val client = 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

val health = Health(client)

val response = 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.

Endpoint
GET /health/time
Kotlin
import io.appwrite.Client
import io.appwrite.coroutines.CoroutineCallback
import io.appwrite.services.Health

val client = 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

val health = Health(client)

val response = health.getTime()
Copyright © 2024 Appwrite