Web API for Dr.Web AV-Desk
Administrator Manual
Chapter 1. Web API for Dr.Web AV-Desk
1.1. Introduction
Copyright
About Manual
Conventions and Abbreviations
1.2. Integration of Dr.Web AV-Desk with third-party software via the Web API
Chapter 2. Web API 4.0
2.1. General Structure of Response Documents
Response in XML format
Response in JSON format
2.2. Stations Handling
Create a New Station
Change Station Parameters
Delete a Station
Restore a Station
Get Station Information
Get Station Statistics
Get Stations List by a State
Get State of Specified Station
Get States of Stations
Send a Message to a Station
Remote Launch of Stations Scanning
Update Components by Stations
Reboot Station
Get the Quarantine State
Get Newbies Information
Get Installing Components List
Get Installed Components List
Get Running Components List
Get Modules List
Get Virus Databases List
Get Station Location Data
Get Stations List of Specified User
2.3. Groups Handling
Add a New Group
Change Group Parameters
Delete Group
Get Groups List
Get Group Information
Get Group Statistics
Send a Message to Stations of a Group
Remote Launch of Scanning on Stations of a Group
Update Components on Stations of a Group
Reboot Stations of a Group
Get the List of Stations of a Group
Get the Quarantine State
Get Location Data of Stations of a Group
Get Installing Components List for a Group
2.4. Server Handling
Server Information
Repository Status
Get Server statistics on detected threats
Run a Job
Get Server Encryption Public Keys
Search for Stations and Groups
Get Information about License Keys
Get Server Statistics on Stations Scan
Get Server Statistics on Resources Usage
2.5. Tariffs Handling
Add a Tariff Group
Change Tariff Group Parameters
Delete Tariff Group
Get Tariff Group Information
Get Tariff Groups List
Get the List of Stations of a Tariff Group
2.6. Administrators Handling
Adding Administrator
Changing Administrator Parameters
Deleting Administrator
Administrator Information
Administrators List
2.7. Quarantine Handling
Restore Objects from Quarantine
Rescan Objects from Quarantine
Delete Objects from Quarantine
Chapter 3. Migration from XML API 3.x to Web API
3.1. Common Changes
3.2. Stations Handling
3.3. Groups Handling
3.4. Server Handling
3.5. Tariffs Handling
3.6. Administators Handling
3.7. Quarantine Handling
Appendix A. Permissions
Appendix B. Components
B1. Installing Components
B2. Component Codes
Appendix C. Returned error codes
Appendix D. Returned station state codes
Appendix E. XML API 2.x
E1. Get Station Information
E2. Create a New Station
E3. Change Station Information
E4. Delete a Station
Appendix F. XML API 3.x
F1. Get Station Information
F2. Create a New Station
F3. Change Station Information
F4. Delete a Station
F5. Group List
F6. Server Statistics
© Doctor Web, 2017