Tenable Security Center API: Director Scan Zone

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

/mgmt/zone

Methods
GET

Gets the list of Director Scan Zones. NOTE: A Director Scan Zone is Director's copy of a Scan Zone from an 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
*sci
**ipList
**createdTime
**modifiedTime
**organizations
**activeScanners
**totalScanners
**scanners


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
{
    "type": "regular",
    "response": [
        {
            "id": "1",
            "name": "sci1 scan zone",
            "description": "",
            "ipList": "0.0.0.0/0",
            "createdTime": "1615926375",
            "modifiedTime": "1615926375",
            "scanners": [
                {
                    "id": "1",
                    "name": "192.168.1.1",
                    "description": "",
                    "status": "2"               }
            ],
            "organizations": [],
            "activeScanners": 0,
            "totalScanners": 1,
            "SCI": {
                "id": "2",
                "name": "sci1",
                "description": ""           }
        }
    ],
    "error_code": 0,
    "error_msg": "",
    "warnings": [],
    "timestamp": 1615926995
}
POST

Adds a Scan Zone to a specified SCI, returning a Director Scan Zone ID.

Request Parameters
Expand
1
2
3
4
5
6
7
8
9
10
11
{
    "name" : <string>,
    "description" : <string> DEFAULT "",
    "sciID" : <number>,
    "ipList" : <string> (valid IP list),
    "scanners" : [
        {
            "id" : <number>       }...
    ],
    "organizations" : []
}
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
{
    "type": "regular",
    "response": {
        "id": "2",
        "name": "Test-Zone-1615928553",
        "description": "",
        "ipList": "0.0.0.0/0",
        "sciID": "2",
        "sciZoneID": "2",
        "createdTime": "1615928574",
        "modifiedTime": "1615928574",
        "scanners": [
            {
                "id": "1",
                "name": "192.168.1.2",
                "description": "",
                "status": "2"           }
        ],
        "organizations": [],
        "activeScanners": 0,
        "totalScanners": 1
    },
    "error_code": 0,
    "error_msg": "",
    "warnings": [],
    "timestamp": 1615928574
}

/mgmt/zone/{id}

Methods
PATCH

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

Request Parameters

(All fields are optional)

See /mgmt/zone::POST for parameters.

Example Response
See /mgmt/zone/{id}::GET
DELETE

Deletes the Director Zone 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" : 1408733643
}
GET

Gets the Director Scan Zone associated with {id}. A Director Scan Zone is Director's copy of a Scan Zone from an 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
*sci
**ipList
**createdTime
**modifiedTime
**organizations
**activeScanners
**totalScanners
**scanners


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
{
    "type": "regular",
    "response": {
        "id": "1",
        "name": "sci1 scan zone",
        "description": "",
        "ipList": "0.0.0.0/0",
        "createdTime": "1615926375",
        "modifiedTime": "1615926375",
        "scanners": [
            {
                "id": "1",
                "name": "192.168.1.2",
                "description": "",
                "status": "2"           }
        ],
        "organizations": [],
        "activeScanners": 0,
        "totalScanners": 1,
        "SCI": {
            "id": "2",
            "name": "sci1",
            "description": ""       }
    },
    "error_code": 0,
    "error_msg": "",
    "warnings": [],
    "timestamp": 1615928128
}