Kaspersky Research Sandbox provides an API to obtain a list of available execution environments (both default and custom).
Request
Request method: GET
Endpoint: https://<server name>/api/v1/sandbox/exec_env
Parameters
This endpoint does not require request parameters.
cURL command sample:
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 execution environments.
200 OK
Execution environments list is obtained successfully.
200 OK response parameters
Parameter |
Data type |
Description |
|---|---|---|
|
string |
Name of environment to use via API. |
|
string |
Name of environment name to use via web interface. |
|
string |
Operating system family on which environment is created: Windows, Linux, or Android. |
|
array of objects |
Status of Microsoft software activation with user keys:
This parameter is only available for default images. |
|
boolean |
Indicates whether the image is default (pre-installed) or custom. Available values:
|
|
array of objects |
General information about the operating system:
|
|
string |
Certain network channel specified for the execution environment. Note, if the channel is specified for the environment, it cannot be changed when creating an execution task. |
200 OK response example: { "id": "CentOS7_x64", "name": "CentOS7_x64", "os_family": "Linux", "product_activations": [ { "product": "CentOS7", "activated": true } ], "default": true, "os_info": { "Name": "Centos 7", "Version": "centos-release-7-8.2003.0.el7.centos_x86_64", "Bitness": 64 }, "channel": "" }, { "id": "Win10_x64", "name": "Win10_x64", "os_family": "Windows", "product_activations": [ { "product": "Win10", "activated": true }, { "product": "Office2016", "activated": true } ], "default": true, "os_info": { "Name": "Microsoft Windows 10 Pro", "Version": "10.0.18362", "Bitness": 64 }, "channel": "" } |
400 Bad Request
Failed to obtain list of environments list.
401 Unauthorized
Failed to obtain list of environments due to incorrect user credentials.
500 Internal Server Error
Failed to obtain list of environments list due to an internal server error.
Page top