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 |
|---|---|---|
|
boolean |
Indicates whether objects can be successfully executed in Kaspersky Research Sandbox. Available values:
|
|
array |
Array containing fields described in this table below. |
|
boolean |
Indicates whether an execution environment is valid. Available values:
|
|
boolean |
Indicates whether anti-virus databases are up-to-date. Available values:
|
|
boolean |
Indicates whether Kaspersky Research Sandbox is connected to KPSN. Available values:
|
|
boolean |
Indicates whether the detection scanned (scanner_detects) service is available. Available values:
|
|
boolean |
Indicates whether the file type scanner (scanner_types) service is available. Available values:
|
|
boolean |
Indicates whether the klmr scanner (scanner_klmr) service is available. Available values:
|
|
boolean |
Indicates whether KSN or KPSN is enabled. Available values:
|
|
boolean |
Indicates whether Kaspersky Research Sandbox is connected to KSN. Available values:
|
|
boolean |
Indicates whether Microsoft Windows environment is installed. Available values:
|
|
boolean |
Indicates whether there is enough free space on the server. Available values:
|
|
boolean |
Deprecated parameter, will be deleted in future releases. Indicates whether there is enough free space on the server. Available values:
|
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