Initiate Scan Batch

Url

/file/batch

Method

POST

Request HTTP header parameters:

name

type

required

description

apikey

string

false

User's session id, for e.g.: if rule is role dependent

rule

string

false

Select rule for the batch, if no header given the default rule will be selected (URL encoded string of rule name)

user_agent

string

false

user_agent header for helping Rule selection

user-data

string

false

Additional custom information (max 1024 bytes, URL encoded UTF-8 string)

Result Code

Description

200

Batch id generated in response body

400

Bad request, (e.g.: wrong header values)

403

Access denied

500

Internal server error

HTTP status code: 200

{
"batch_id": "74c85f475147439bac4d33b181853923"
}

HTTP status code: 500, 403, 400

{
"err": <error message>
}