Dr.Web Enterprise Security Suite

Version 13.0

Web API Manual

9/29/2023

• 1. Introduction
  • About Manual
  • Conventions
  • Integration of Dr.Web Enterprise Security Suite with Third-Party Software via the Web API
• 2. General Structure of Response Documents
  • Response in XML format
  • Response in JSON format
• 3. Station Handling
  • Create a Station
  • Change Station Parameters
  • Delete a Station
  • Restore a Station
  • Get Station Information
  • Get Status of Specified Station
  • Get Station Statuses
  • Get Information About Newbie Stations
  • Get a List of Stations by State
  • Get a List of Stations by Type
  • Get Station Statistics
  • Get Statistics on Performed Actions
  • Get Detection Statistics of Preventive Protection
  • Get Quarantine State Information
  • Send a Message to a Station
  • Start Station Scanning
  • Station Reboot Launch
  • Update Components by Stations
  • Get a List of Components to Install
  • Get a List of Installed Components
  • Get a List of Running Components
  • Get a List of Modules
  • Get a List of Virus Databases
  • Get Information About Products on a Station
  • Get Station Location Data
• 4. Group Handling
  • Create a Group
  • Change Group Parameters
  • Delete a Group
  • Get Group Information
  • Get a List of Groups
  • Get a List of Stations in a Group
  • Get Group Statistics
  • Get Statistics on Actions Performed Within a Group
  • Get Detection Statistics of Preventive Protection for a Group
  • Get Quarantine State Information for a Group
  • Send a Group Message
  • Run a Group Scanning
  • Initiate Station Restart in a Group
  • Initiate Component Update in a Group
  • Manage Station Blocking Settings
  • Get a List of Components to Install for a Group
  • Get Location Data of Stations in a Group
• 5. Dr.Web Server Handling
  • Get Dr.Web Server Information
  • Get Repository Status Information
  • Get Repository Update Information
  • Get Dr.Web Server Statistics on Detected Threats
  • Run a Job
  • Get Dr.Web Server Encryption Public Keys
  • Search for Stations and Groups
  • Get Information About License Keys
  • Get Dr.Web Server Statistics on Station Scanning
  • Get Dr.Web Server Statistics on Resource Usage
  • Get a List of Documentation Links
• 6. Quarantine Handling
  • Restore Objects From Quarantine
  • Rescan Objects From Quarantine
  • Delete Objects From Quarantine
• 7. Administrator Handling
  • Create an Administrator Account
  • Change an Administrator Account
  • Change Administrator Privileges
  • Change Privileges of a Group Administrator
  • Delete an Administrator Account
  • Get Administrator Information
  • Get a List of Administrators
• 8. Administrator Group Handling
  • Create an Administrator Group
  • Change Administrator Group Parameters
  • Delete an Administrator Group
  • Get Administrator Group Information
  • Get a List of Administrator Groups
• Appendix A. Privileges
  • A1. Station Privilege Codes
  • A2. Administrator Privileges
• Appendix B. Components
  • B1. Installation of Components
  • B2. Component Codes
• Appendix C. Returned Error Codes
• Appendix D. Returned Station State Codes
• Appendix E. Returned Update Codes
• Technical Support
• Legal Notes

© Doctor Web, 2023