Title	Edit Core integration details
Group	admin
URL Path	vault_rest/settings/mdcore/{id}
Method	PUT

Http return	200, 400, 401, 403, 500
Table of Contents	Summary Use Cases (used by) HTTP header parameters HTTP body parameters Descriptions of request: Request Error Response Example of successful Core integration status change request: Descriptions of response:
Last Updated	06 Aug 2019

Summary

Changes Core integration details within Vault.

Use Cases (used by)

Used by Web Client to

edit Core integration settings.
enable and disable Core integrations

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

HTTP body parameters

HTTP body	json	REQUIRED

Sample HTTP body

{
    "api_key": null,
    "detect_scan_errors": false,
    "id": 3,
    "on_error": {
        "do_action": "none"
    },
    "on_infected": {
        "do_action": "none"
    },
    "on_timeout": {
        "do_action": "none"
    },
    "rule_name": "MetaDefender Vault",
    "timeout": 180,
    "url": "http://192.168.16.222:8008/metascan_rest",
    "user_agent": "vault",
    "status": "disabled"
}

Descriptions of request:

api_key	If MetaDefender Core is password protected this is the password.	string value
detect_scan_errors	If true then scan errors will not be ignored.	boolean value
id	Core ID within Vault	integer value
rule_name	Rule name from Core that will be used with this Vault	string value
timeout	Number of seconds before timing out if scan is not complete	integer value (should be long enough to prevent scan failures of large files)
url	The URL endpoint where MetaDefender Core REST is available	string value
user_agent
status	New status to be applied to this Core integration, either: enabled disabled	string value
on_infected	Actions to be performed when file is found to be infected.
on_infected.notifications	Specify who to notify when file is 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.notifications	Specify who to notify when an error occurs while scanning
on_error.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.notifications	Specify who to notify when file did not complete scanning
on_timeout.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.

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 Core integration status change request:

{
    "message": "Success",
    "ui_message_key": null,
    "last_update": "08\/06\/2019 14:52:41",
    "metascan_url": "http:\/\/192.168.16.222:8008\/metascan_rest"
}

Descriptions of response:

message	Returns "Success" if the operation succeeded.	string value
ui_message_key	A message key that is useful for localization	string value
last_update	Last time Core integration was updated	string value
metascan_url	Core url	string value