Tenable Security Center API: Director Scanner

This API resource is only usable in Tenable.sc Director.

/mgmt/scanner

Methods
GET

Gets the list of Scanners. A Director Scanner is a Director's copy of a Scanner from a SCI. 

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
ip
port
*SCI
sciScannerID
useProxy
enabled
verifyHost
managePlugins
*authType
cert
username
password
**agentCapable
accessKey
secretKey
version
webVersion
admin
msp
numScans
numHosts
numSessions
numTCPSessions
loadAvg
uptime
*status
pluginSet
loadedPluginSet
serverUUID
createdTime
modifiedTime
zones
nessusManagerOrgs
certInfo
eolDate
eouDate


Legend

* = always comes back
** = comes back if fields list not specified on GET all

Request 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
44
45
46
47
48
49
{
    "type":"regular",
    "response":[
        {
            "name":"172.26.102.241",
            "ip":"172.26.102.241",
            "port":"8834",
            "version":"8.13.1",
            "status":"1",
            "uptime":"5617814",
            "modifiedTime":"1616049747",
            "msp":"false",
            "admin":"false",
            "agentCapable":"false",
            "pluginSet":"202103122332",
            "id":"1",
            "authType":"password",
            "eolDate":1672444800,
            "SCI":{
                "id":"2",
                "name":"172.26.103.72",
                "description":"Update"          }
        },     
        {
            "name":"96",
            "ip":"172.26.103.96",
            "port":"8834",
            "version":"8.13.1",
            "status":"1",
            "uptime":"4146250",
            "modifiedTime":"1616061157",
            "msp":"false",
            "admin":"false",
            "agentCapable":"false",
            "pluginSet":"202103122332",
            "id":"2",
            "authType":"certificate",
            "eolDate":1672444800,
            "SCI":{
                "id":"2",
                "name":"172.26.103.72",
                "description":"Update"          }
        }
    ],
    "error_code":0,
    "error_msg":"",
    "warnings":[],
    "timestamp":1616326074
}

POST

Adds a Scanner to an SCI.

Request Parameters
Expand
1
2
3
4
5
6
7
8
9
10
11
12
13
14
15
16
17
18
19
20
21
22
{
    "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",
    "managePlugins" : <string> "true" | "false" DEFAULT "false",
    "agentCapable" : <string> "true" | "false" DEFAULT "false",
    "sciID" : <number>    "zones" : [
        {
            "id" : <number>        }...
    ] DEFAULT [],
    "nessusManagerOrgs" : [
        {
            "id" : <number>        }...
    ] DEFAULT [],
    "accessKey" : <string> DEFAULT "",
    "secretKey" : <string> DEFAULT ""...
}

authType "certificate"

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

authType "password"

1
2
3
...
    "username" : <string>,
    "password" : <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
42
43
44
45
{
    "type":"regular",
    "response":{
        "id":"3",
        "name":"NewScanner",
        "description":"NewScanner",
        "ip":"172.1.2.3",
        "port":"8834",
        "sciID":"2",
        "sciScannerID":"3",
        "useProxy":"false",
        "enabled":"true",
        "verifyHost":"false",
        "managePlugins":"false",
        "authType":"password",
        "cert":null,
        "username":"nonadmin",
        "password":"SET",
        "agentCapable":"false",
        "version":null,
        "webVersion":null,
        "admin":"false",
        "msp":"false",
        "numScans":"0",
        "numHosts":"0",
        "numSessions":"0",
        "numTCPSessions":"0",
        "loadAvg":"0.0",
        "uptime":"-1",
        "status":"8192",
        "pluginSet":null,
        "loadedPluginSet":null,
        "serverUUID":null,
        "accessKey":null,
        "secretKey":null,
        "createdTime":"1616328669",
        "modifiedTime":"1616328669",
        "eolDate":-1,
        "eouDate":-1
    },
    "error_code":0,
    "error_msg":"",
    "warnings":[],
    "timestamp":1616328669
}

/mgmt/scanner/{id}

Methods
GET

Gets the Scanner associated with Director {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
ip
port
*SCI
sciScannerID
useProxy
enabled
verifyHost
managePlugins
*authType
cert
username
password
**agentCapable
accessKey
secretKey
version
webVersion
admin
msp
numScans
numHosts
numSessions
numTCPSessions
loadAvg
uptime
*status
pluginSet
loadedPluginSet
serverUUID
createdTime
modifiedTime
zones
nessusManagerOrgs
certInfo
eolDate
eouDate


Legend

* = always comes back
** = comes back if fields list not specified on GET all

Request 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
44
45
46
47
48
49
50
51
52
53
54
55
56
57
58
{
 
    "type":"regular",
    "response":{
        "authType":"password",
        "admin":"false",
        "useProxy":"false",
        "verifyHost":"false",
        "enabled":"true",
        "cert":"",
        "username":"admin",
        "password":"SET",
        "description":"",
        "createdTime":"1616049747",
        "loadedPluginSet":"202103122332",
        "pluginSet":"202103122332",
        "webVersion":"8.13.1 (Build 257)",
        "version":"8.13.1",
        "agentCapable":"false",
        "accessKey":"",
        "secretKey":"",
        "msp":"false",
        "loadAvg":"0.0",
        "numHosts":"0",
        "numScans":"0",
        "numSessions":"0",
        "numTCPSessions":"0",
        "serverUUID":"fa3e3f8e-6d15-0c5d-0b95-691c22b9a06179f48589955bc7aa",
        "name":"172.26.102.241",
        "ip":"172.26.102.241",
        "port":"8834",
        "status":"1",
        "uptime":"5618713",
        "modifiedTime":"1616049747",
        "id":"1",
        "eolDate":1672444800,
        "zones":[
            {
                "id":"1",
                "name":"Default Scan Zone",
                "description":""            }
        ],
        "nessusManagerOrgs" : [
            {
                "id" : "1",
                "name" : "My Org",
                "description" : ""          }
        ]
        "SCI":{
            "id":"2",
            "name":"172.26.103.72",
            "description":"Update"      }
    },
    "error_code":0,
    "error_msg":"",
    "warnings":[],
    "timestamp":1616326821
}


PATCH

Edits the Scanner associated with Director{id}, changing only the passed in fields.

Request Parameters

(All fields are optional)

See /scanner::POST for parameters.

Note: The sciID is not changeable on a Director Scanner. 

Example Response

See /scanner/{id}/::GET

DELETE

Deletes the Scanner associated with Director {id}.

Request Parameters

None

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