8.1.7.2. Modify 'skip by hash' list
The API for change of the "skip by hash"
Request |
Value |
Method |
PUT |
URL |
/admin/config/skip |
Request HTTP header parameters:
name |
type |
required |
value |
apikey |
string |
true |
Session id, can be acquired by Login / Create a Session |
Request body:
JSON path |
Type |
Required |
Value |
skip |
object |
true |
Contains a hash object that contains a comment and an array of the engines to be skipped |
blacklist |
object |
true |
|
Example:
{
"blacklist"
: {
"edecbf6bd03ef340e0c6cd438a4069c2"
: {
"comment"
:
"example3"
}
},
"skip"
: {
"13d8b8329bd2f668e6a889f32feaa48c832dbf0c"
: {
"comment"
:
"example4"
,
"engines"
: [
"totaldefense"
]
},
"7f6cf37bd817f2c7572f5467578d38bb4dc7080b"
: {
"comment"
:
"Example1"
,
"engines"
: [
"eset"
,
"clamav"
]
}
},
"whitelist"
: {
"6e340b9cffb37a989ca544e6bb780a2c78901d3fb33738768511a30617afa01d"
: {
"comment"
:
"example5"
},
"df72d035b31b1ff89f752e83af14b9e9dcf4913d9954f074546860d10b6908fb"
: {
"comment"
:
"example2"
}
}
}
The request body containing whitelist's rules in array under "whitelist" key;
Each object in the array represents a whitelist:
comment: same comment for detailed more information this whitelist settings.
engines: containing engine id's strings in array
hash: md5, sha1 or sha256 hash
Successful response
HTTP status code: 200
{
"blacklist"
: {
"edecbf6bd03ef340e0c6cd438a4069c2"
: {
"comment"
:
"example3"
}
},
"skip"
: {
"13d8b8329bd2f668e6a889f32feaa48c832dbf0c"
: {
"comment"
:
"example4"
,
"engines"
: [
"totaldefense"
]
},
"7f6cf37bd817f2c7572f5467578d38bb4dc7080b"
: {
"comment"
:
"Example1"
,
"engines"
: [
"eset"
,
"clamav"
]
}
},
"whitelist"
: {
"6e340b9cffb37a989ca544e6bb780a2c78901d3fb33738768511a30617afa01d"
: {
"comment"
:
"example5"
},
"df72d035b31b1ff89f752e83af14b9e9dcf4913d9954f074546860d10b6908fb"
: {
"comment"
:
"example2"
}
}
}
The response returned the modified whitelist
Each object in the array represents a whitelist:
comment: same comment for detailed more information this whitelist settings.
engines: containing engine id's strings in array
hash: md5, sha1 or sha256 hash
Error response
Internal error
HTTP status code: 404
{
"err"
:
"<error message>"
}
Invalid api key or rights
HTTP status code: 403
{
"err"
:
"Access denied"
}
Unexpected event on server
HTTP status code: 500
{
"err"
:
"<error message>"
}
Note: Check Metadefender Core server logs for more information.