About This Guide

Welcome to the MetaDefender Cloud guide. This guide is intended to provide the information you need to:

Start analyzing files with 20+ anti-malware engines

How to use MetaDefender Cloud Public APIs

Learn about new features, updated features, and bug fixes Learn about frequently asked questions and additional concepts through our library of knowledge base articles

Key Features of MetaDefender Cloud

File Analysis - Analyzing binaries with 20+ anti-malware engines

Deep CDR (aka Content Disarm and Reconstruction) with support for 100+ file types

Sandbox dynamic analysis to detect more unknown and targeted attacks

Binary vulnerability data assessment

IP-Domain reputation

Threat Intelligence Feeds

Server
https://api.metadefender.com/v4
Server Variables

Apikey

The apikey and related limits can be found in the account page. It is generated automatically when the account is created.

The apikey is used for all API requests to MetaDefender Cloud service.

Apikey info

Retrieve information about your apikey such as (but not limited to): max file size, API limits, created date, expiration date, and account nickname.

Auth
Headers
apikeystring

The apikey identifies and authenticates the user.

GET /apikey/
Copy
Responses
200

The request has succeeded

404

The requested page was not found

Apikey limits

Retrieve information about the consumed limits for an apikey. Every time a request is made to an endpoint that consumes a specific limit, it will be reflected in this endpoint. It is the equivalent of the X-RateLimit-Used from the response headers. Depending on your license, your rate limit will reset daily or monthly.

Auth
Headers
apikeystring

The apikey identifies and authenticates the user.

GET /apikey/limits
Copy
Responses
200

The request has succeeded

Headers
X-Authenticatedstring

Indicates the source of authentication.

X-Response-Timestring

Indicates the response time expressed in milliseconds.

Body
Apikey usageobject
reputation_apiint32

The consumed Reputation API limits for the apikey

threat_intel_search_apiint32

The consumed Threat Intel Search API limits for the apikey

prevention_apiint32

The consumed Prevention API limits for the apikey

feed_apiint32

The consumed Feed API limits for the apikey

download_fileint32

The consumed limits for file downloads for the apikey

sandbox_apiint32

The consumed Dynamic Analysis API limits for the apikey

404

The requested page was not found

Response
Copy

Apikey scan history

Retrieve a paginated list of files uploaded by the user in reverse chronological order (newest to oldest). The pagination is controlled by the user (how many items per page and which page) by specifying the limit and offset query parameters in the request. The response only contains a summary of the files, with minimum information.

Auth
Headers
apikeystring

The apikey identifies and authenticates the user.

Query String
limitinteger

Pagination - how many entries you want to return.

offsetinteger

Pagination - how many entries to skip (sorted chronologically).

cursorstring

Utilize a string-based cursor for efficient pagination in database queries. This approach enhances performance and should be used in place of the traditional offset parameter.

searchstring

An optional search term used to filter results based on hash or file display name.

GET /apikey/scan-history
Copy
Responses
200

The request has succeeded

404

The requested page was not found

Apikey remaining limits

Retrieve information about the remaining limits for an apikey.

Auth
Headers
apikeystring

The apikey identifies and authenticates the user.

GET /apikey/limits/status
Copy
Responses
200

The request has succeeded

Apikey usageobject
reputation_apiint32

The remaining Reputation API limits for the apikey

threat_intel_search_apiint32

The remaining Threat Intel Search API limits for the apikey

prevention_apiint32

The remaining Prevention API limits for the apikey

feed_apiint32

The remaining Feed API limits for the apikey

download_fileint32

The remaining limits for file downloads for the apikey

sandbox_apiint32

The remaining Dynamic Analysis API limits for the apikey

throttling_limitint32

The remaining Throttling limits for the apikey

404

The requested page was not found

Response
Copy