Run a Job

Request Parameters

Parameter

Description

Mandatory

action

Action to be applied to a newbie station.

Valid values:

approve—grant access to the Dr.Web Server for a station;

cancelonconnect—cancel the action scheduled to be performed next time a station connects to the Dr.Web Server;

reject—reject the station.

no

group

Group a newbie station will be added to

no

id

Newbie station ID

no

task-id

Job ID.

Valid values:

newbies—set an action to be applied to a newbie station,

update_repositories—run the Dr.Web Server repository update.

yes

 

The action, group, and id parameters are specified only if task-id=newbies.

If the action parameter is set to approve, the group parameters must be specified.

 

Request Examples

1.For task-id=newbies:

https://192.168.1.1:9081/api/server/tasks.ds?task-id=newbies&action=approve&group=_notfound_&id=001

2.For task-id=update_repositories:

https://192.168.1.1:9081/api/server/tasks.ds?task-id=update_repositories

If the Dr.Web Server repository update has already been initiated, the success status will come in response to the task-id=update_repositories request.

XML and JSON response structure examples are described below.

 

XML Response

1.For task-id=newbies:

<drweb-es-api api_version="4.3.0" timestamp="1582030324" server="192.168.1.1" srv_version="12.00.0.201909260" status="true">
  <task id="newbies" status="failed" message="Group is not found"/>
</drweb-es-api>

2.For task-id=update_repositories:

<drweb-es-api api_version="4.3.0" timestamp="1582030324" server="192.168.1.1" srv_version="12.00.0.201909260" status="true">
  <task id="update_repositories" status="failed" message="Not enough privileges to perform the operation"/>
</drweb-es-api>

 

Description of XML Response Parameters

The <task /> element contains information about completion of a job specified in the request.

The <task /> element attributes:

Attribute

Description

id

Job ID:

newbies—set an action to be applied to a newbie station,

update_repositories—a job to update the Dr.Web Server repository.

status

Job execution state:

success—job successfully executed,

failed—job failed.

message

Error message if a job failed. If the job was completed successfully, the message attribute contains an empty message string.

 

JSON Response Structure

1.For task-id=newbies

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

    "timestamp": 1582030580,

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

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

      "version": "12.00.0.201909260",
      "uuid": "27671337-e0b0-4f60-aeb0-ab1f2ca47f77"}},

"data": {
    "task": {
      "id": "newbies",

      "status": "failed",
      "message": "Group is not found"}}}

2.For task-id=update_repositories:

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

    "timestamp": 1582030580,

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

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

      "version": "12.00.0.201909260",
      "uuid": "1023dcd7-d11d-b211-896d-8804c0842edb"}},

"data": {
    "task": {
      "id": "update_repositories",

      "status": "failed",
      "message": "Not enough privileges to perform the operation"}}}

 

Description of JSON Response Parameters

The task block contains information about completion of a job specified in the request.

The task block elements:

Field name

Description

id

Job ID:

newbies—set an action to be applied to a newbie station,

update_repositories—a job to update the Dr.Web Server repository.

message

Error message if a job failed. If the job was completed successfully, the message element contains an empty message string.

status

Job execution state:

success—job successfully executed,

failed—job failed.