8.1.10.3. Generate Yara package

Request

Value

Method

POST

URL

/yara/generate

Request HTTP header parameters:

name

type

required

value

apikey

string

true

Session id, can be acquired by 8.1.1.1. Login / Create a Session

Successful response

HTTP status code: 200

{
"status": "idle",
"start_time": "",
"issues": {
"general": [
{
"severity": "warning",
"message": "Error while extracting network source. Can not open destination."
}
],
"<source>": [
{
"severity": "warning",
"message": "The given local source does not exists."
}
],
}
}

The response is the is the actual state of generation process.

status: can be "idle", "error" or "inprogress"
start_time: used only when status is inprogress, otherwise its empty.
issues: stores a map of issues. Each key represents the according source, except "general", which contains general errors occurred during the generation process.

Error response

Internal error

HTTP status code: 500

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

Invalid api key or rights

HTTP status code: 403

{
"err": "Access denied"
}

Note: Check Metadefender Core server logs for more information.