Obtaining the Suricata file

Kaspersky Research Sandbox provides an API to obtain the custom (uploaded by user) Suricata rule file of the specified task.

Request

Request method: GET

Endpoint: https://<server name>/api/v1/sandbox/tasks/<task ID>/suricata

Parameters

Obtaining the custom Suricata file parameters

Parameter	Data type	Occurrence	Description
`task_id`	string	Required	Object execution task ID (GUID).

cURL command sample:

$ curl --user <user name> --request GET 'https://<server name>/api/v1/sandbox/tasks/<task ID>/suricata'

You will be asked to enter your password. The password is not displayed while you type it.

Responses

Endpoint returns the custom Suricata file.

200 OK

Custom Suricata file obtained successfully.

400 Bad Request

Failed to obtain the Suricata file due to incorrect query.

400 Bad Request response parameters

Parameter	Data type	Description
`code`	string	Error ID.
`message`	string	Error description.
`meta`	string	Additional information, if available.

Error examples:

Incorrect task_id parameter:

{"code":6,"message":"task not found"}

Incorrect task_id parameter format:

{"code":29,"message":"bad task id"}

401 Unauthorized

Failed to obtain the custom Suricata file due to incorrect user credentials.

404 Not Found

The specified task was not found or does not have a custom Suricata file.

500 Internal Server Error

Failed to obtain a custom Suricata file due to an internal server error.