1.4 Apikey remaining limits

Request

Value

Method

GET

URL

https://api.metadefender.com/v4/apikey/limits/status

Summary

Retrieve information about the remaining limits for an apikey.

Request

Header Parameters

 

Description

Allowed Values

Required

apikey

Gives rights to use the endpoint (API Authentication Mechanisms)

apikey

YES

Response

HTTP Status Codes

Please refer to Status Codes for more information.

Body

Example of a successful request:

{
"reputation_api": 3999,
"prevention_api": 100,
"download_file": 100,
"analysis_api": 50000
}

Example of a failed request:

{
"error": {
"code": 404008,
"messages": [
"The apikey was not found"
]
}
}

Descriptions of response:

reputation_api

The limit used for Reputation API

prevention_api

The limit used for Prevention API

download_file

The limit corresponding for malware sharing

analysis_api

The limit corresponding to Sandbox API

For understanding what these limits are, please see https://metadefender.opswat.com/licensing

Errors

Please refer to Errors for more information.

Sample code (Node.js)

var http = require("https");
 
var options = {
"method": "GET",
"hostname": [
"api",
"metadefender",
"com"
],
"path": [
"v4",
"apikey",
"limits",
"status"
],
"headers": {
"apikey": + process.env.APIKEY
}
};
 
var req = http.request(options, function (res) {
var chunks = [];
 
res.on("data", function (chunk) {
chunks.push(chunk);
});
 
res.on("end", function () {
var body = Buffer.concat(chunks);
console.log(body.toString());
});
});
 
req.end();

Sample code (cURL)

curl -X GET \
https://api.metadefender.com/v4/apikey/limits/status \
-H "apikey: ${APIKEY}"