Get Core integrations

Title

Get MetaDefender Core list

Group

admin

URL Path

vault_rest/settings/mdcores

Method

GET

Http return

200, 400, 401, 403, 500

Table of Contents

Last Updated

06 Aug 2019

Summary

Returns a list of MetaDefender Core integrations.

Use Cases (used by)

Used by Web Client to display MetaDefender Core integration list.

HTTP header parameters

Authorization

The API key of the caller

REQUIRED

This header should have the following format: Bearer [API key obtained from the authenticate API]
Example: Bearer Cp01BwnXAIOLZXxn7yogjKqIZnZpQD

Request Error

400

Bad Request

Invalid HTTP request

401

Unauthorized

One or more parameters are invalid

403

Forbidden

API key is incorrect

500

Internal Server Error

Server is temporarily unavailable

Response

Example of successful get MetaDefender Core settings request:

{
"items": [
{
"api_key": null,
"detect_scan_errors": false,
"id": 2,
"on_error": {
"do_action": "delete"
},
"on_infected": {
"do_action": "delete"
},
"on_timeout": {
"do_action": "none"
},
"rule_name": "MetaDefender Vault",
"timeout": 180,
"url": "http:\/\/192.168.16.222:8008\/metascan_rest",
"user_agent": "vault",
"status": "enabled"
},
{
"api_key": null,
"detect_scan_errors": false,
"id": 3,
"on_error": {
"do_action": "delete"
},
"on_infected": {
"do_action": "delete"
},
"on_timeout": {
"do_action": "none"
},
"rule_name": "MetaDefender Vault",
"timeout": 180,
"url": "http:\/\/192.168.16.229:8008\/metascan_rest",
"user_agent": "vault",
"status": "enabled"
}
]
}

Descriptions of response:

items

Array with all the integrated Cores

array

api_key

API key used to add the core instance

string value

detect_scan_errors

If true then scan errors will not be ignored.

boolean value

id

Core ID within Vault

integer value

detect_scan_errors

If true then scan errors will not be ignored.

boolean value

rule_name

Rule that Core will apply for this Vault

string value

timeout

Time before aborting file scan, in seconds

integer value

url

Core url

string value

user_agent

User agent variable to link

string value

status

Core status. Can be "enabled" or "disabled"

string value

on_infected

Actions to be performed when file is found to be infected.

 

on_infected.do_action

Specify what to do with the file when is infected

  • None (do nothing)

  • Delete (delete the file)

Delete means permanently deleting the file.

on_error

Actions to be performed when an error occurs during scanning.

 

on_error.do_action

Specify what to do with the file when an error has occurred while scanning it.

  • None (do nothing)

  • Delete (delete the file)

Delete means permanently deleting the file.

on_timeout

Actions to be performed when scan did not complete in time.

This can happen if timeout is not long enough

on_timeout.do_action

Specify what to do with the file when is not completely scanned

  • None (do nothing)

  • Delete (delete the file)

Delete means permanently deleting the file.