Get a List of Documentation Links

Request Parameter

Parameter

Description

Mandatory

language

Documentation Language

Available values:

cn—Chinese,

de—German,

en—English,

es—Spanish,

fr—French,

it—Italian,

ja—Japanese,

kk—Kazakh,

pl—Polish,

ru—Russian,

uk—Ukrainian.

no

 

Response will contain a link to English or Russian version of the document if there is no document on Dr.Web Server in the language specified in the request.

 

Request Example

https://192.168.1.1:9081/api/server/pdfdoc.ds?language=es

XML and JSON response structure examples are described below.

 

XML Response Structure

<drweb-es-api api_version="4.3.0" timestamp="1587328217" server="192.168.1.1" srv_version="12.00.0.201909260" status="true">

  <docs>
    <admin>
        <doc title="Administrator Manual" file="admin-manual.pdf" link="/pdf/en/admin-manual.pdf"/>

        <doc title="Installation Manual" file="install-manual.pdf" link="/pdf/es/install-manual.pdf"/>

        <doc title="Appendices" file="appendices.pdf" link="/pdf/en/appendices.pdf"/>

        <doc title="Anti-virus Network Quick Installation Guide" file="quick-install.pdf" link="/pdf/es/quick-install.pdf"/>

        <doc title="Dr.Web Server Database Manual" file="database-manual.pdf" link="/pdf/en/database-manual.pdf"/>

        <doc title="Web API Manual" file="web-api.pdf" link="/pdf/en/web-api.pdf"/>
    </admin>

    <manager>
        <doc title="Managing the workstations under Windows" file="agent-windows.pdf" link="/pdf/en/agent-windows.pdf"/>

        <doc title="Managing the workstations under macOS" file="agent-macos.pdf" link="/pdf/en/agent-macos.pdf"/>

        <doc title="Managing the workstations under Android" file="agent-android.pdf" link="/pdf/en/agent-android.pdf"/>

        <doc title="Managing Dr.Web for Linux" file="agent-linux.pdf" link="/pdf/en/agent-linux.pdf"/>

        <doc title="Managing Microsoft Exchange Server" file="agent-exchange.pdf" link="/pdf/en/agent-exchange.pdf"/>

        <doc title="Managing Dr.Web for UNIX File Servers" file="agent-unix-fs.pdf" link="/pdf/en/agent-unix-fs.pdf"/>

        <doc title="Managing Dr.Web for UNIX Mail Servers" file="agent-unix-ms.pdf" link="/pdf/en/agent-unix-ms.pdf"/>

        <doc title="Managing Dr.Web for UNIX Internet Gateways" file="agent-unix-igw.pdf" link="/pdf/en/agent-unix-igw.pdf"/>
    </manager>

    <user>
        <doc title="Dr.Web Agent for Windows" file="user-manual-windows.pdf" link="/pdf/en/user-manual-windows.pdf"/>
    </user>
  </docs>
</drweb-es-api>

 

Description of XML Response Parameters

The <docs /> element contains the list of document links to Dr.Web Enterprise Security Suite 13.0 product.

Nested elements of the <docs /> element:

Element

Description

<admin />

The list of Dr.Web Server administrator Manuals

<manager />

The list of station handling administrator Manuals

<user />

The list of station user Manuals

Web API Manual refers to <admin /> group of documents.

The <doc /> element of nested <admin />, <manager /> and <user /> elements contains specific document parameters.

The <doc /> element attributes:

Attribute

Description

title

Document title

file

Document file in PDF format

links

Link to a document hosted on the Dr.Web Server

 

JSON Response Structure

{ "head": {
    "status": true,

    "timestamp": 1588773342,

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

    "server": {
      "name": "192.168.1.1",

      "version": "12.00.0.201909260",
      "uuid": "78b77680-8080-11ea-701a-44a527d9115c"}},

  "data": {
    "admin": [
        {"file": "admin-manual.pdf",
         "link": "/pdf/en/admin-manual.pdf",
         "title": "Administrator Manual"},

        {"file": "install-manual.pdf",
         "link": "/pdf/es/install-manual.pdf",
         "title": "Installation Manual"},

        {"file": "appendices.pdf",
         "link": "/pdf/en/appendices.pdf",
         "title": "Appendices"},

        {"file": "quick-install.pdf",
         "link": "/pdf/es/quick-install.pdf",
         "title": "Anti-virus Network Quick Installation Guide"},

        {"file": "database-manual.pdf",
         "link": "/pdf/en/database-manual.pdf",
         "title": "Dr.Web Server Database Manual"},

        {"file": "web-api.pdf",
         "link": "/pdf/en/web-api.pdf",
         "title": "Web API Manual"}],

    "manager": [
        {"file": "agent-windows.pdf",
         "link": "/pdf/en/agent-windows.pdf",
         "title": "Managing the workstations under Windows"},

        {"file": "agent-macos.pdf",
         "link": "/pdf/en/agent-macos.pdf",
         "title": "Managing the workstations under macOS"},

        {"file": "agent-android.pdf",
         "link": "/pdf/en/agent-android.pdf",
         "title": "Managing the workstations under Android"},

        {"file": "agent-linux.pdf",
         "link": "/pdf/en/agent-linux.pdf",
         "title": "Managing Dr.Web for Linux"},

        {"file": "agent-exchange.pdf",
         "link": "/pdf/en/agent-exchange.pdf",
         "title": "Managing Microsoft Exchange Server"},

        {"file": "agent-unix-fs.pdf",
         "link": "/pdf/en/agent-unix-fs.pdf",
         "title": "Managing Dr.Web for UNIX File Servers"},

        {"file": "agent-unix-ms.pdf",
         "link": "/pdf/en/agent-unix-ms.pdf",
         "title": "Managing Dr.Web for UNIX Mail Servers"},

        {"file": "agent-unix-igw.pdf",
         "link": "/pdf/en/agent-unix-igw.pdf",
         "title": "Managing Dr.Web for UNIX Internet Gateway"}],

    "user": [
        {"file": "user-manual-windows.pdf",
         "link": "/pdf/en/user-manual-windows.pdf",
         "title": "Dr.Web Agent for Windows"}]}}

 

Description of JSON Response Parameters

data block contains the list of document links to Dr.Web Enterprise Security Suite 13.0 product.

The data block elements:

Field name

Description

admin

Array with the list of Dr.Web Server administrator Manuals

manager

Array with the list of station handling administrator Manuals

user

Array with the list of station user Manuals

Web API Manual refers to admin group of documents.

Every object of admin, manager and user arrays contains the information on specific document.

Object elements of admin, manager and user arrays:

Field name

Description

file

Document file in PDF format

links

Link to a document hosted on the Dr.Web Server

title

Document title