Response in JSON Format

To receive a response in the JSON format, add the format=json parameter to your request, so it looks like this:

https://<host>:9081/api/<object>/<script>.ds?<parameters>&format=json

where:

<host>—IP address or DNS name of a computer with the Dr.Web Server installed;

<object>—managed object: station, group, Dr.Web Server, administrator, Quarantine.

Available request scripts and their parameters are described in the following sections:

4. Station Handling,

5. Group Handling,

6. Dr.Web Server Handling,

7. Quarantine Handling,

8. Administrator Handling,

9. Administrator Group Handling.

The “-” sign in script title can be replaced with the “_” sign. Thus, responses to requests based on installed-components.ds or installed_components.ds scripts will be the same.

You can receive a JSON response for any HTTP request supported by Web API 4.3.0.

JSON document contains the following main elements:

the head block—for service information,

the data block—for response data. Content in this block depends on operation to be executed.

Elements of the head block:

Field name

Description

status

Request status. true—means a request has been processed successfully, false—means an error occurred and a request has not been processed.

timestamp

Dr.Web Server GMT time (Unix timestamp format)

version in the api block

Current Web API version

versionString in the api block

Current Web API version in string format

name in the server block

Dr.Web Server domain name or IP address

version in the server block

Full version of Dr.Web Enterprise Security Suite

uuid in the server block

Dr.Web Server ID

If there was any error ("status": false) during the operation, the response would include the error block with error description and code. The error would be described in the message field and error code would be in the code field.

{ "head": {
    "status": false,

    "timestamp": 1579467853,

    "api": {
      "version": 40300,
      "versionString": 4.3.0},

    "server": {
      "name": "192.168.1.1",
      "version": "12.00.0.201909260"}},

"data": {
    "error": {
       "code": 11,
       "message": "Necessary parameters are not specified in your request: 'name'"}}}

See Appendix C. Returned Error Codes for a list of possible error codes.

Date and time in all elements of all Web API 4.3.0 scripts are returned in the Unix timestamp format.