Obtaining system health status

Kaspersky Research Sandbox provides an API that allows you to determine whether an object can be successfully executed. For example, the application may be unstable because one of the services is not working, or there is not enough free disk space.

Request

Request method: GET

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

Parameters

This endpoint does not require request parameters.

cURL command sample:

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

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

Responses

Endpoint returns Kaspersky Research Sandbox health status indicator.

200 OK

Health status is obtained successfully.

200 OK response parameters

Parameter

Data type

Description

healthy

boolean

Indicates whether objects can be successfully executed in Kaspersky Research Sandbox.

Available values:

  • true—Kaspersky Research Sandbox is stable, you can run object execution tasks.
  • false—Kaspersky Research Sandbox is not stable, execution tasks cannot be processed correctly.

detailed

array

Array containing fields described in this table below.

sb_is_dead

boolean

Indicates whether an execution environment is valid.

Available values:

  • true—Execution environment is not stable, you cannot run object execution tasks.
  • false—Execution environment is stable, you can run object execution tasks.

av_components_are_expired

boolean

Indicates whether anti-virus databases are up-to-date.

Available values:

  • true—Anti-virus databases are not up-to-date, execution tasks cannot be processed correctly. Update databases before running tasks.
  • false—Anti-virus databases are up-to-date, you can run object execution tasks.

kpsn_is_dead

boolean

Indicates whether Kaspersky Research Sandbox is connected to KPSN.

Available values:

  • true—Kaspersky Research Sandbox is not connected to KPSN, execution tasks cannot be processed correctly.
  • false—Kaspersky Research Sandbox is connected to KPSN, you can run object execution tasks.

scanner_detects_is_dead

boolean

Indicates whether the detection scanned (scanner_detects) service is available.

Available values:

  • true—The scanner_detects service is not active, execution tasks cannot be processed correctly.
  • false—The scanner_detects service is active, you can run object execution tasks.

scanner_types_is_dead

boolean

Indicates whether the file type scanner (scanner_types) service is available.

Available values:

  • true—The scanner_types service is not active, execution tasks cannot be processed correctly.
  • false—The scanner_types service is active, you can run object execution tasks.

scanner_klmr_is_dead

boolean

Indicates whether the klmr scanner (scanner_klmr) service is available.

Available values:

  • true—The scanner_klmr service is not active, execution tasks cannot be processed correctly.
  • false—The scanner_klmr service is active, you can run object execution tasks.

ksn_kpsn_disabled

boolean

Indicates whether KSN or KPSN is enabled.

Available values:

  • true—Both KSN and KPSN are disabled.
  • false—KSN or KSPN is enabled.

ksn_is_dead

boolean

Indicates whether Kaspersky Research Sandbox is connected to KSN.

Available values:

  • true—Kaspersky Research Sandbox is not connected to KSN. The value is also true when KSN is disabled.
  • false—Kaspersky Research Sandbox is connected to KSN.

no_windows_exec_environments

boolean

Indicates whether Microsoft Windows environment is installed.

Available values:

  • true—Microsoft Windows environment is not installed, execution tasks cannot be processed correctly.
  • false—Microsoft Windows environment is installed, execution tasks can be processed correctly.

insufficient_disk_space

boolean

Indicates whether there is enough free space on the server.

Available values:

  • true—Less than 10% of free space is available, tasks cannot be processed correctly. Free up server hard drive space before running tasks.
  • false—Free space is sufficient, you can run object execution tasks.

path_state

boolean

Deprecated parameter, will be deleted in future releases.

Indicates whether there is enough free space on the server.

Available values:

  • true—Free space is sufficient, you can run object execution tasks.
  • false—Less than 10% of free space is available, tasks cannot be processed correctly. Free up server hard drive space before running tasks.

400 Bad Request

Failed to obtain Kaspersky Research Sandbox health status.

401 Unauthorized

Failed to obtain Kaspersky Research Sandbox health status due to incorrect user credentials.

500 Internal Server Error

Failed to obtain Kaspersky Research Sandbox health status due to an internal server error.

Page top