1.1 Apikey info
Request |
Value |
Method |
GET |
URL |
https://api.metadefender.com/v4/apikey/ |
Summary
Retrieve information about an apikey.
Request
Header Parameters
|
Description |
Allowed Values |
Required |
apikey |
Gives rights to use the endpoint (API Authentication Mechanisms), and also identifies the user |
apikey |
YES |
Response
HTTP Status Codes
Please refer to Status Codes for more information.
Body
Example of a successful request:
{
"max_upload_file_size"
:
140
,
"max_archive_file_size"
:
140
,
"max_archive_file_number"
:
50
,
"limit_prevention"
:
40
,
"limit_reputation"
:
4000
,
"limit_sandbox"
:
1
,
"limit_feed"
:
1000
,
"qos_scan"
:
"normal"
,
"updated_at"
:
"2019-02-21T09:12:36.275Z"
,
"created_at"
:
"2019-02-21T09:12:36.275Z"
,
"portal_api_key"
:
"1981b1387c84f2f1465ae14994b96c5c"
,
"source"
:
"mdcloud_fingerprint"
,
"workflow_rule"
:
0
,
"votes"
: [],
"vulnerability_submissions"
: [],
"expiration_date"
:
"1970-01-01T00:00:00.000Z"
,
"time_interval"
:
"daily"
,
"nickname"
:
"throbbing_band_caae"
,
"paid_user"
:
0
}
Example of a failed request:
{
"error"
: {
"code"
:
404008
,
"messages"
: [
"The apikey was not found"
]
}
}
Descriptions of response:
max_upload_file_size |
The maximum upload size for files (expressed in MB) |
max_archive_file_size |
The maximum upload size for archives (expressed in MB) |
max_archive_file_number |
The maximum number of files contained in an archive |
limit_prevention |
The limit corresponding to Prevention API |
limit_reputation |
The limit corresponding to Reputation API |
limit_sandbox |
The limit corresponding to Sandbox API |
limit_feed |
The limit corresponding to Feed API |
qos_scan |
The selected scan queue, based on the apikey type |
updated_at |
The last date when the apikey information was updated |
created_at |
The date when the apikey was created |
portal_api_key |
The queried apikey |
expiration_date |
The expiration date of the apikey (if this is in the future, it means that this is a paid apikey) |
time_interval |
The reset interval for the apikey limits |
nickname |
The nickname of the user correlated to the queried apikey |
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"
,
""
],
"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/ \
-H
"apikey: ${APIKEY}"