Why am I getting API failures or timeouts?

When integrating an application with MetaDefender Core via REST API, you might encounter API failures, timeouts. To troubleshoot the cause of the issue, please follow these steps.

API Error Messages

When interacting with MetaDefender Core via REST API, it is essential that you familiarize yourself with the meaning of the various Coded Responses and Error Messages.

For example, if you get 5xx responses, it usually indicates issues on MetaDefender Core server side, such as engines failed/inactive.

Resource usage on the server

During periods of high resource usage, caused by high loads, timeouts on processing requests can also occur.

You can monitor for current system load on the MetaDefender Core web management console: Dashboard → System Health.

Core service availability

If MetaDefender Core sits behind a load balancer that performs periodic health checks (GET /readyz) or if your integrated application performs health checks, the instance might be unavailable if it’s unhealth.

Refer to this documentation on Heath Check Configuration and ensure that the service is healthy.

Firewall blocking traffic

If the MetaDefender Core ports and address isn’t allowed by the Firewall, API calls to the instance will also fail.

Please make sure that MetaDefender Core server’s IP address and port (default is port 8008) is allowed by the Firewall.

API rate limiting

If API rate limit has been configured for MetaDefender Core’s NGINX web server, API calls might also fail due to the rate limit.

For more information, please refer to this documentation on API Rate Limiting.

Scan failures triggered by real-time protection

In some cases, MetaDefender Core scans can be disrupted by real-time protection systems present on the machine. To remediate this issue, please refer to How to Mitigate Scan Failures in MetaDefender Core Triggered by Real-Time Protection Systems?