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
GraphQL
query {
    healthGet {
        ping
        status
    }
}

Get Antivirus

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

Endpoint
GET /health/anti-virus
GraphQL
query {
    healthGetAntivirus {
        version
        status
    }
}

Get Cache

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

Endpoint
GET /health/cache
GraphQL
query {
    healthGetCache {
        ping
        status
    }
}

Get DB

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

Endpoint
GET /health/db
GraphQL
query {
    healthGetDB {
        ping
        status
    }
}

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
GraphQL
query {
    healthGetQueueCertificates {
        size
    }
}

Get Functions Queue

Endpoint
GET /health/queue/functions
GraphQL
query {
    healthGetQueueFunctions {
        size
    }
}

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
GraphQL
query {
    healthGetQueueLogs {
        size
    }
}

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
GraphQL
query {
    healthGetQueueWebhooks {
        size
    }
}

Get Local Storage

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

Endpoint
GET /health/storage/local
GraphQL
query {
    healthGetStorageLocal {
        ping
        status
    }
}

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
GraphQL
query {
    healthGetTime {
        remoteTime
        localTime
        diff
    }
}
Copyright © 2024 Appwrite