Monitoring

Overview

The /readyz API provides a simple way to monitor the health and status of your MetaDefender Downloader instance. This endpoint is particularly valuable for air-gapped environments where active monitoring of engine updates and system health is required.

API Endpoint

GET /readyz

Query Parameters

The API accepts an optional info query parameter with the following possible values:

Parameter ValueDescription
versionReturns the MetaDefender Downloader version
updater_server_connectionChecks connectivity to the updater server
diskspaceReports free and total disk space for the data directory (in bytes)
engineReturns status of all engine and database packages
updateProvides update-related information including timestamps and status
allReturns all information listed above. Note: when using all , if other options also included -> it will be considered as invalid option

Multiple values can be requested by separating them with commas (e.g., info=diskspace,version).

Default Response

When called without the info parameter, the API returns:

  • Downloader version
  • Connection status to updater server

Example Requests

Basic Health Check

GET /readyz

Response:

Javascript
Copy

Request Specific Information

GET /readyz?info=diskspace,updater_server_connection

Response:

Javascript
Copy

Request All Available Information

GET /readyz?info=all

Response:

Javascript
Copy

Response Codes

Status CodeDescription
200Request successful
400Invalid parameter(s) provided

Error Handling

If an invalid info parameter is supplied, the API returns:

GET /readyz?info=invalid

Response:

Javascript
Copy

Monitoring Best Practices

  1. Regular Polling: Set up automated checks every 5-15 minutes
  2. Alert on Failures: Configure alerts for:
    • Disconnected updater server
    • Low disk space (below 10% free)
    • Failed update status

Implementation Notes

  • Disk space is reported in bytes
  • If engines are actively downloading, the updater server connection is automatically considered "connected"
Type to search, ESC to discard
Type to search, ESC to discard
Type to search, ESC to discard
On This Page
MonitoringOverviewAPI EndpointQuery ParametersDefault ResponseExample RequestsBasic Health CheckRequest Specific InformationRequest All Available InformationResponse CodesError HandlingMonitoring Best PracticesImplementation Notes