To receive a response in the XML format, send a request in the following format:
http://<host>:9080/api/<object>/<script>.ds?<parameters> |
or
https://<host>:9081/api/<object>/<script>.ds?<parameters> |
where:
<host>—IP address or DNS name of a computer with the Server installed
<object>—managing object: station, group, Server, administrator, Quarantine.
Available scripts and their parameters are described in the following sections:
|
The ‘-’ character in the script name can be replaced with ‘_’. For example, responses to requests using the scripts installed-components.ds and installed_components.ds will be the same. |
As a response, you receive an xml document with the following content:
<drweb-es-api api_version="4.3.0" timestamp="1550867853" server="192.168.1.1" srv_version="12.00.0.201909260" status="true"> |
Attributes of the <drweb-es-api /> root element
Attribute |
Description |
|---|---|
api_version |
Current Web API version |
timestamp |
GMT time of server (Unix timestamp format) |
server |
Server domain name or IP address |
srv_version |
Full version of Dr.Web Web API for Enterprise Security Suite |
status |
Request status. Request status: true—a request has been processed successfully, false—an error occurred, a request has not been processed. |
If an error occurred during operation (status=’false’), then the <error/> element containing an error code and description will be included in the XML body. An error is described in the <message/> element while an error code is in the <errno/> element.
<drweb-es-api api_version="4.3.0" timestamp="1553850629" server="192.168.1.1" srv_version="12.00.0.201909260" status="false"> <message>Unable to remove group '411dac63-2a3e-4ce8-af4f-1fbeb94242ef': You cannot remove the system group</message> |
Error codes are given in the Returned error codes section.
Date and time in all elements of Web API 4.3.0 scripts are returned in the Unix timestamp format.