3.9.1 MetaDefender Core specific inventory properties

Query parameters

Addresses specified in CORE URI ADDRESS may contain optional query parameters for specific use cases.

Syntax

With the optional query parameters the Core URI is formatted as follows:

URI schema with query parameter
scheme://host:port[?query]

Valid parameters

Name

Value

Use case

Example

apikey

32 characters long API key of an account that belongs to the role the Core side rule is restricted to.

Core side rules may be restricted to roles (for details see 3.6.4. Security rule configuration in MetaDefender Core v4 documentation). Email Security can use these rules if:

  1. A user is created on Core,

    1. That belongs to the role the Core side rule is restricted to;

    2. And the user has an API key generated.

  2. In Email Security the Core is added to a server profile

    1. And the API key above is specified in the Core URI.

URI example with query parameter
https://127.0.0.1:8058?apikey=24a586f3023b4309b65aa1974198d6c6

Rule

Right after the CORE URI ADDRESS has been specified, and is valid (connection can be established) the RULE drop-down list is populated with the available rules on the corresponding MetaDefender Core instance.

images/download/attachments/26167898/image2017-8-11_9-0-16.png

The desired security rule may be selected from the configured Core's available rules. Default is Automatic.

Please note that if the security rules on the configured MetaDefender Core under Policy > Security rules are limited to a specific user agent other than mdicapserver or restricted to specific roles other than what is specified in the server URI, then those security rules will not be available in MetaDefender ICAP Server.

MetaDefender ICAP Server identifies itself on MetaDefender Core with the user agent mdicapserver.

images/download/attachments/26167898/image2017-7-6_16-19-29.png

On the example below the Core rule File process with Kiosk and File process with SFT are not listed in ICAP Server as those rules are restricted to user agent kiosk and sft respectively.

Otherwise all unrestricted core rules are in the list. images/download/attachments/26167898/image2017-9-8_13-6-15.png