Obtaining system configuration

Kaspersky Research Sandbox provides an API to obtain information about the updated components and application version, including the build version.

Request

Request method: GET

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

Parameters

This endpoint does not require request parameters.

cURL command sample:

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

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 information about the updated components and Kaspersky Research Sandbox version.

200 OK

System configuration information is obtained successfully.

200 OK response parameters

Parameter

Data type

Description

system_version

string

Kaspersky Research Sandbox version, including build number (for example: 2.1.0.3000).

bases_version

string <date-time>

Date and time when the components were last updated, specified in the ISO 8601:2004 format (YYYY-MM-DDThh:mm:ssZ).

200 OK response example:

{

"system_version": "2.1.0.3000",

"bases_version": ""

}

401 Unauthorized

Failed to obtain system configuration parameters due to incorrect user credentials.

404 Not Found

Failed to obtain system configuration parameters.

500 Internal Server Error

Failed to obtain system configuration parameters due to an internal server error.

Page top