Obtaining channels list

Kaspersky Research Sandbox provides an API to obtain a list of available network channels, which can be used by the object to access the internet.

Request

Request method: GET

Endpoint: https://<server name>/api/v1/sandbox/channels

Parameters

This endpoint does not require request parameters.

cURL command sample:

$ curl --user <user name> --request GET 'https://<server name>/api/v1/sandbox/channels'

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

Responses

Endpoint returns a JSON object that contains a list of available network channels.

200 OK

Network channels list is obtained successfully.

200 OK response parameters

Parameter	Data type	Description

`ID`	integer	Integer network channel identifier (for example, `0` or `1`).
`Name`	string	Network channel name used in Kaspersky Research Sandbox.
`Available`	boolean	Indicates the network channel availability: `true`—Network channel is available. `false`—Network channel is not available.
200 OK response example: [ { "ID": 0, "Name": "Tarpit", "Available": true, }, { "ID": 1, "Name": "DigitalNetwork", "Available": true, } ]

400 Bad Request

Failed to obtain network channels list.

401 Unauthorized

Failed to obtain network channels list due to incorrect user credentials.

500 Internal Server Error

Failed to obtain network channels list due to an internal server error.