Docs
Skip to content
get

Get antivirus

Endpoint

gethttps://<REGION>.cloud.appwrite.io/v1/health/anti-virus

Description

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

Required scopes

health.read

Authentication

Initialize the Appwrite client with setProject() and a server API key (setKey()). For direct REST calls, send X-Appwrite-Project and X-Appwrite-Key.
Status
Content type
200
application/json

Health Antivirus

Name
Type
Description
string

Antivirus version.

disabled | offline | online

Antivirus status. Possible values are: disabled, offline, online

JavaScript
const sdk = require('node-appwrite');


const client = new sdk.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


const health = new sdk.Health(client);


const result = await health.getAntivirus();