Tenable Security Center API: Director Scan

This API resource is only available for administrators in Tenable.sc Director.

/mgmt/scan

Methods
GET

Gets the list of Scans for the specified SCI linked to Director or all SCIs if no parameter is specified.

Fields Parameter
Expand

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

    ?fields=<field>,...

Allowed Fields

*id
*uuid
**name
**description
**status
**SCI
**organization
sciScanID
policy
creator
owner
repository
zone
plugin
type
ipList
dhcpTracking
classifyMitigatedAge
emailOnLaunch
emailOnFinish
timeoutAction
scanningVirtualHosts
rolloverType
status
maxScanTime
inactivityTimeout
createdTime
modifiedTime

Legend

* = always comes back
** = comes back if fields list not specified

red = field is a JSON object ( e.g. "SCI" : {"id" : "2", "name" : "SCI Name", "description" : "Description"} )

Request Parameters
Expand

Parameters can be passed in as a query string if specified in the format of: /mgmt/scan?sciID=<id> or in the request as JSON.

Optional 

{
	"sciID" : <number>,
    "orgID" : <number>}
Example Response
Expand

No query parameters specified to get all SCI Scans.

{
    "error_code": 0,
    "error_msg": "",
    "response": [
        {
            "id": "2",
            "uuid": "6821F741-EF4C-46BA-98AA-E1CD93456220",
            "name": "Basic Scan",
            "description": "",
            "status": "0",
            "SCI": {
                "id": "2",
                "name": "SCI 1",
                "description": ""            },
            "organization": {
                "id": "2",
                "name": "Org 1",
                "description": ""            }
        },
        {
            "id": "5",
            "uuid": "09698C92-B1A2-4526-BA9F-4B4A6B0F81BE",
            "name": "Advanced Scan",
            "description": "",
            "status": "0",
            "SCI": {
                "id": "3",
                "name": "SCI 2"                "description": ""            },
            "organization": {
                "id": "3",
                "name": "Org 2",
                "description": ""            }
        }
    ],
    "timestamp": 1643230109,
    "type": "regular",
    "warnings": []
}

Query parameter specified for SCI #3: /mgmt/scan?sciID=3

{
    "error_code": 0,
    "error_msg": "",
    "response": [
        {
            "id": "5",
            "uuid": "09698C92-B1A2-4526-BA9F-4B4A6B0F81BE",
            "name": "Advanced Scan",
            "description": "",
            "status": "0",
            "SCI": {
                "id": "3",
                "name": "SCI 2"                "description": ""            },
            "organization": {
                "id": "3",
                "name": "Org 2",
                "description": ""            }
        }
    ],
    "timestamp": 1643230109,
    "type": "regular",
    "warnings": []
}
POST

Adds a Scan to the specified SCI.

Request Parameters
Expand 
{
	"name" : <string>,
	"type" : <string> DEFAULT "policy",
    "description" : <string> DEFAULT "",
	"sciID" : <number>,
    "userUUID" : <string>,
    "policyUUID" : <string>,
    "repositoryUUID" : <string>,
    "zoneUUID" : <string> DEFAULT "",
    "dhcpTracking" : <string> DEFAULT "false",
    "classifyMitigatedAge" : <number> DEFAULT "0",
    "schedule" : {
        "type" : "dependent" | "ical" | "never" | "rollover" | "template" <string> DEFAULT "template"        "start" : <string> (This value takes the iCal format),
        "repeatRule" : <string> (This value takes the repeat rule format),
        "enabled" : <string> "false" | "true" DEFAULT "true"    },
    "assets" : [
        {
            "id" : <number>        }...
    ] DEFAULT [],
    "emailOnLaunch" : <string> "false" | "true" DEFAULT "false",
    "emailOnFinish" : <string> "false" | "true" DEFAULT "false",
    "timeoutAction" : <string> "discard" | "import" | "rollover" DEFAULT "import",
    "scanningVirtualHosts" : <string> "false" | "true" DEFAULT "false",
    "rolloverType" : <string> "nextDay" | "template" DEFAULT "template",
    "ipList" : <string> DEFAULT "",
    "maxScanTime" : <number> DEFAULT "3600",
	"inactivityTimeout" : <number> DEFAULT "12"}
Example Response
Expand 
{
	"type": "regular",
	"response": {
		"id": "43",
		"uuid": "B0DD6E59-850B-421B-9498-74DE0177CF64",
		"ownerUUID": "F7791B94-A722-4C77-A722-7529CF19D68D",
		"creatorUUID": "F7791B94-A722-4C77-A722-7529CF19D68D",
		"name": "Basic Scan",
		"description": "Description",
		"sciScanID": "1",
		"ipList": "192.26.28.0/24",
		"type": "policy",
		"policyUUID": "91E02A57-505A-4BF6-95B0-AA4C5CCBFBDC",
		"pluginID": "-1",
		"repositoryUUID": "6ED5492E-0D90-401B-892D-D1DAF28EAC12",
		"zoneUUID": "",
		"dhcpTracking": "true",
		"classifyMitigatedAge": "0",
		"emailOnLaunch": "false",
		"emailOnFinish": "false",
		"timeoutAction": "rollover",
		"scanningVirtualHosts": "false",
		"rolloverType": "template",
		"status": "0",
		"maxScanTime": "unlimited",
		"inactivityTimeout": "12",
		"createdTime": "1646429871",
		"modifiedTime": "1646433443",
		"SCI": {
			"id": "4",
			"name": "SCI 3",
			"description": ""		},
		"organization": {
			"id": "3",
			"name": "Org 4",
			"description": ""		}
	},
	"error_code": 0,
	"error_msg": "",
	"warnings": [],
	"timestamp": 1647528708
}


/mgmt/scan/{id}

/mgmt/scan/{uuid}

Methods
GET

Gets the SCI Scan associated with {id} or {uuid} on Director.

Fields Parameter
Expand

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

    ?fields=<field>,...

Allowed Fields

*id
*uuid
**name
**description
**status
**SCI
**organization
**sciScanID
**policy
**creator
**owner
**repository
**zone
**plugin
**type
**ipList
**dhcpTracking
**classifyMitigatedAge
**emailOnLaunch
**emailOnFinish
**timeoutAction
**scanningVirtualHosts
**rolloverType
**status
**maxScanTime
**inactivityTimeout
**createdTime
**modifiedTime

Legend

* = always comes back
** = comes back if fields list not specified

red = field is a JSON object ( e.g. "SCI" : {"id" : "2", "name" : "SCI Name", "description" : "Description"} )

Request Parameters

None

Example Response
Expand 
{
	"type": "regular",
	"response": {
		"id": "43",
		"uuid": "B0DD6E59-850B-421B-9498-74DE0177CF64",
		"ownerUUID": "F7791B94-A722-4C77-A722-7529CF19D68D",
		"creatorUUID": "F7791B94-A722-4C77-A722-7529CF19D68D",
		"name": "Basic Scan",
		"description": "Description",
		"sciScanID": "1",
		"ipList": "192.26.28.0/24",
		"type": "policy",
		"policyUUID": "91E02A57-505A-4BF6-95B0-AA4C5CCBFBDC",
		"pluginID": "-1",
		"repositoryUUID": "6ED5492E-0D90-401B-892D-D1DAF28EAC12",
		"zoneUUID": "",
		"dhcpTracking": "true",
		"classifyMitigatedAge": "0",
		"emailOnLaunch": "false",
		"emailOnFinish": "false",
		"timeoutAction": "rollover",
		"scanningVirtualHosts": "false",
		"rolloverType": "template",
		"status": "0",
		"maxScanTime": "unlimited",
		"inactivityTimeout": "12"		"createdTime": "1646429871",
		"modifiedTime": "1646433443",
		"SCI": {
			"id": "4",
			"name": "SCI 3",
			"description": ""		},
		"organization": {
			"id": "3",
			"name": "Org 4",
			"description": ""		}
	},
	"error_code": 0,
	"error_msg": "",
	"warnings": [],
	"timestamp": 1647528708
}
DELETE

Deletes the Scan associated with {id} or {uuid} on Director.

Request Parameters

None

Example Response
Expand 
{
	"type" : "regular",
	"response" : "",
	"error_code" : 0,
	"error_msg" : "",
	"warnings" : [],
	"timestamp" : 1408733643
}