Skip to main content

createScanTaskByMac

Use this method to generate a scan task for managed endpoints identified by their MAC address.

Parameters

Parameter

Type

Optional

Description

macAddresses

Array

No

The list of mac addresses of the endpoints to be scanned. You can specify at most 100 MAC addresses at once.

type

Number

No

The type of scan. Available options: 1 - quick scan; 2 - full scan; 3 - memory scan; 4 - custom scan

name

String

Yes

The name of the task. If the parameter is not passed, the name will be generated automatically.

customScanSettings

Array

No

Object containing information such as scan depth and scan path(s). This object should be set only when type parameter has the value 4 - Custom scan. When set for other types, the values will be ignored. Parameter $customScanSettings must contain the following properties:int $scanDepth The scan profile. Available options: 1 - aggressive; 2 - normal; 3 - permissivearray $scanPath The list of target paths to be scanned

returnTaskId

Boolean

Yes

Indicates if the request will return the ID of the new task. Possible values:

  • true, will return the ID of the newly created task, if the request is successful.

  • false, will not return the ID of the newly created task. Instead, it will return a Boolean value.

Default value: False.

Return value

This method returns the ID of the newly created task or a boolean value which is true if the creation of the task was successful.

Example

Request:

  {
       "params": {
           "macAddresses": [
               "1c67da49e1a1",
               "8c67f849e1a8"
           ],
           "type": 4,
           "name": "my scan",
           "customScanSettings": {
               "scanDepth": 1,
               "scanPath": [ 
                   "LocalDrives"
               ]
           },
           "returnTaskId":true
       },
       "jsonrpc": "2.0",
       "method": "createScanTaskByMac",
       "id": "787b5e36-89a8-4353-88b9-6b7a32e9c87f"
  }

Response:

  {
      "id": "787b5e36-89a8-4353-88b9-6b7a32e9c87f",
      "jsonrpc":"2.0",
      "result": 6372b7a3897aaa77ee021642
  }
In this section: