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.services.Health

suspend fun main() {
    val client = Client(context)
      .setEndpoint("https://[HOSTNAME_OR_IP]/v1") // Your API Endpoint
      .setProject("5df5acd0d48c2") // Your project ID
      .setKey("919c2d18fb5d4...a2ae413da83346ad2") // Your secret API key

    val health = Health(client)
    val response = health.get()
    val json = response.body?.string()
}

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.services.Health

suspend fun main() {
    val client = Client(context)
      .setEndpoint("https://[HOSTNAME_OR_IP]/v1") // Your API Endpoint
      .setProject("5df5acd0d48c2") // Your project ID
      .setKey("919c2d18fb5d4...a2ae413da83346ad2") // Your secret API key

    val health = Health(client)
    val response = health.getAntivirus()
    val json = response.body?.string()
}

Get Cache

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

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

suspend fun main() {
    val client = Client(context)
      .setEndpoint("https://[HOSTNAME_OR_IP]/v1") // Your API Endpoint
      .setProject("5df5acd0d48c2") // Your project ID
      .setKey("919c2d18fb5d4...a2ae413da83346ad2") // Your secret API key

    val health = Health(client)
    val response = health.getCache()
    val json = response.body?.string()
}

Get DB

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

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

suspend fun main() {
    val client = Client(context)
      .setEndpoint("https://[HOSTNAME_OR_IP]/v1") // Your API Endpoint
      .setProject("5df5acd0d48c2") // Your project ID
      .setKey("919c2d18fb5d4...a2ae413da83346ad2") // Your secret API key

    val health = Health(client)
    val response = health.getDB()
    val json = response.body?.string()
}

Get Certificates Queue

Get the number of certificates that are waiting to be issued against Letsencrypt in the Appwrite internal queue server.

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

suspend fun main() {
    val client = Client(context)
      .setEndpoint("https://[HOSTNAME_OR_IP]/v1") // Your API Endpoint
      .setProject("5df5acd0d48c2") // Your project ID
      .setKey("919c2d18fb5d4...a2ae413da83346ad2") // Your secret API key

    val health = Health(client)
    val response = health.getQueueCertificates()
    val json = response.body?.string()
}

Get Functions Queue

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

suspend fun main() {
    val client = Client(context)
      .setEndpoint("https://[HOSTNAME_OR_IP]/v1") // Your API Endpoint
      .setProject("5df5acd0d48c2") // Your project ID
      .setKey("919c2d18fb5d4...a2ae413da83346ad2") // Your secret API key

    val health = Health(client)
    val response = health.getQueueFunctions()
    val json = response.body?.string()
}

Get Logs Queue

Get the number of logs that are waiting to be processed in the Appwrite internal queue server.

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

suspend fun main() {
    val client = Client(context)
      .setEndpoint("https://[HOSTNAME_OR_IP]/v1") // Your API Endpoint
      .setProject("5df5acd0d48c2") // Your project ID
      .setKey("919c2d18fb5d4...a2ae413da83346ad2") // Your secret API key

    val health = Health(client)
    val response = health.getQueueLogs()
    val json = response.body?.string()
}

Get Webhooks Queue

Get the number of webhooks that are waiting to be processed in the Appwrite internal queue server.

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

suspend fun main() {
    val client = Client(context)
      .setEndpoint("https://[HOSTNAME_OR_IP]/v1") // Your API Endpoint
      .setProject("5df5acd0d48c2") // Your project ID
      .setKey("919c2d18fb5d4...a2ae413da83346ad2") // Your secret API key

    val health = Health(client)
    val response = health.getQueueWebhooks()
    val json = response.body?.string()
}

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.services.Health

suspend fun main() {
    val client = Client(context)
      .setEndpoint("https://[HOSTNAME_OR_IP]/v1") // Your API Endpoint
      .setProject("5df5acd0d48c2") // Your project ID
      .setKey("919c2d18fb5d4...a2ae413da83346ad2") // Your secret API key

    val health = Health(client)
    val response = health.getStorageLocal()
    val json = response.body?.string()
}

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.services.Health

suspend fun main() {
    val client = Client(context)
      .setEndpoint("https://[HOSTNAME_OR_IP]/v1") // Your API Endpoint
      .setProject("5df5acd0d48c2") // Your project ID
      .setKey("919c2d18fb5d4...a2ae413da83346ad2") // Your secret API key

    val health = Health(client)
    val response = health.getTime()
    val json = response.body?.string()
}
Copyright © 2024 Appwrite