8.1.3.5. Fetching available processing rules

The response is an array of available rules

Request

Value

Note

Method

GET

 

URL

/file/rules

 

URL

/file/workflows

Same as /file/rules, deprecated

Request HTTP header parameters:

name

type

required

value

notes

user_agent

string

optional

The user agent string value sent in the header (specified by the client).

Only those rules are returned, that:

  1. Match the client's user agent sent using the user_agent header, or

  2. Are not restricted to a specific user agent.

For details see KB article What are Security Policies and how do I use them?.

Successful response

HTTP status code: 200

The response contains the available rules:

[
{
"max_file_size": 200000000,
"name": "File scan"
},
{
"max_file_size": 200000000,
"name": "File scan w/o archive"
}
]

Response description:

  • max_file_size: Maximum file size for files scanned in bytes.

  • name: A unique identifier for identify in the used rule for a scan.

Error response

Unexpected event on server

HTTP status code: 500

{
"err": "<error message>"
}

Note: Check Metadefender Core server logs for more information.