Tenable Security Center API: Passive Scanner (NNM)

/passivescanner

Methods
GET

Gets the list of Nessus Network Monitors.

Fields Parameter
Expand

The fields parameter should be specified along the query string, and it takes the syntax

    ?fields=<field>,...

Allowed Fields

*id
**name
**description
**status
ip
port
useProxy
enabled
verifyHost
authType
cert
username
password
version
webVersion
admin
uptime
pluginSet
loadedPluginSet
lastReportTime
createdTime
modifiedTime
repositories

Legend

* = always comes back

** = comes back if fields list not specified on GET all
Request Query Parameters

None

Example Response
Expand
1
2
3
4
5
6
7
8
9
10
11
12
13
14
15
16
17
18
19
20
21
22
23
24
25
26
27
28
29
30
31
32
33
34
35
36
37
38
39
40
41
42
43
{
    "type" : "regular",
    "response" : [
        {
            "id" : "1",
            "name" : "My Nessus Network Monitor",
            "description" : "",
            "ip" : "192.168.1.1",
            "port" : "8835",
            "useProxy" : "false",
            "enabled" : "true",
            "verifyHost" : "true",
            "authType" : "password",
            "cert" : null,
            "username" : "nonadmin",
            "password" : "SET",
            "version" : null,
            "webVersion" : null,
            "admin" : "false",
            "uptime" : -1,
            "status" : "8",
            "pluginSet" : null,
            "loadedPluginSet" : null,
            "lastReportTime" : "0",
            "lastCommunication" : "0",
            "createdTime" : "1402434305",
            "modifiedTime" : "1402434804",
            "repositories" : [
                {
                    "id" : "100",
                    "name" : "Test Repo 192.168.1.0\/16",
                    "description" : "",
                    "dataFormat" : "IPv4",
                    "type": "Local",
                    "uuid": "FC06DB42-AA49-4BDC-B28F-C60818292339"              },
            ]
        }
    ],
    "error_code" : 0,
    "error_msg" : "",
    "warnings" : [],
    "timestamp" : 1402434305
}
POST

Adds a Nessus Network Monitor.

Request Parameters
Expand
1
2
3
4
5
6
7
8
9
10
11
12
13
14
15
{
    "name" : <string>,
    "description" : <string> DEFAULT "",
    "authType" : <string> "certificate" | "password" DEFAULT "password",
    "ip" : <string>,
    "port" : <number>,
    "useProxy" : <string> "true" | "false" DEFAULT "false",
    "verifyHost" : <string> "true" | "false" DEFAULT "true",
    "enabled" : <string> "true" | "false" DEFAULT "true",
    "repositories" : [
        {
            "id" : <number>       }
    ] DEFAULT []
...
}

authType "certificate"

1
2
3
4
...
    "cert" : <string>,
    "password" : <string> DEFAULT "".
...

authType "password"

1
2
3
4
...
    "username" : <string>,
    "password" : <string>,
    "certificatePassword" : <string>...
Example Response
Expand
1
2
3
4
5
6
7
8
9
10
11
12
13
14
15
16
17
18
19
20
21
22
23
24
25
26
27
28
29
30
31
32
33
34
35
36
37
38
39
40
41
{
    "type" : "regular",
    "response" : {
        "id" : "1",
        "name" : "My Nessus Network Monitor",
        "description" : "",
        "ip" : "192.168.1.1",
        "port" : "8835",
        "useProxy" : "false",
        "enabled" : "true",
        "verifyHost" : "true",
        "authType" : "password",
        "cert" : null,
        "username" : "nonadmin",
        "password" : "SET",
        "version" : null,
        "webVersion" : null,
        "admin" : "false",
        "uptime" : -1,
        "status" : "8",
        "pluginSet" : null,
        "loadedPluginSet" : null,
        "lastReportTime" : "0",
        "lastCommunication" : "0",
        "createdTime" : "1402434305",
        "modifiedTime" : "1402434804",
        "repositories" : [
            {
                "id" : "100",
                "name" : "Test Repo 192.168.1.0\/16",
                "description" : "",
                "dataFormat" : "IPv4",
                "type": "Local",
                "uuid": "FC06DB42-AA49-4BDC-B28F-C60818292339"          },
        ]
    },
    "error_code" : 0,
    "error_msg" : "",
    "warnings" : [],
    "timestamp" : 1401827513
}

/passivescanner/{id}

Methods
GET

Gets the Nessus Network Monitor associated with {id}.

Fields Parameter
Expand

The fields parameter should be specified along the query string, and it takes the syntax

    ?fields=<field>,...

Allowed Fields

*id
**name
**description
**status
ip
port
useProxy
enabled
verifyHost
authType
cert
username
password
version
webVersion
admin
uptime
pluginSet
loadedPluginSet
lastReportTime
createdTime
modifiedTime
repositories

Legend

* = always comes back

** = comes back if fields list not specified on GET all
Request Query Parameters

None

Example Response
Expand
1
2
3
4
5
6
7
8
9
10
11
12
13
14
15
16
17
18
19
20
21
22
23
24
25
26
27
28
29
30
31
32
33
34
35
36
37
38
39
40
41
{
    "type" : "regular",
    "response" : {
        "id" : "1",
        "name" : "My Nessus Network Monitor",
        "description" : "",
        "ip" : "192.168.1.1",
        "port" : "8835",
        "useProxy" : "false",
        "enabled" : "true",
        "verifyHost" : "true",
        "authType" : "password",
        "cert" : null,
        "username" : "nonadmin",
        "password" : "SET",
        "version" : null,
        "webVersion" : null,
        "admin" : "false",
        "uptime" : -1,
        "status" : "8",
        "pluginSet" : null,
        "loadedPluginSet" : null,
        "lastReportTime" : "0",
        "lastCommunication" : "0",
        "createdTime" : "1402434305",
        "modifiedTime" : "1402434804",
        "repositories" : [
            {
                "id" : "100",
                "name" : "Test Repo 192.168.1.0\/16",
                "description" : "",
                "dataFormat" : "IPv4",
                "type": "Local",
                "uuid": "FC06DB42-AA49-4BDC-B28F-C60818292339"          },
        ]
    },
    "error_code" : 0,
    "error_msg" : "",
    "warnings" : [],
    "timestamp" : 1401834305
}
PATCH

Edits the Nessus Network Monitor Scanner associated with {id}, changing only the passed in fields.

Request Parameters

(All fields are optional)

See /passivescanner::POST for parameters.

Example Response
See /passivescanner/{id}::GET
DELETE

Deletes the Nessus Network Monitor associated with {id}, depending on access and permissions.

Request Parameters

None

Example Response
Expand
1
2
3
4
5
6
7
8
{
    "type" : "regular",
    "response" : "",
    "error_code" : 0,
    "error_msg" : "",
    "warnings" : [],
    "timestamp" : 1402435235
}

/passivescanner/updateStatus

POST

Starts an on-demand scanner status update for all Nessus Network Monitors.

Request Parameters

None.

Example Response
Expand
1
2
3
4
5
6
7
8
9
10
11
12
13
14
{
    "type" : "regular",
    "response" : [
        {
            "id" : "1",
            "name" : "My Nessus Network Monitor Scanner",
            "description" : "",
            "status" : "8200"       }
    ],
    "error_code" : 0,
    "error_msg" : "",
    "warnings" : [],
    "timestamp" : 1402435137
}