Tenable.sc API: Lumin

 

/lumin/repositories

Methods
PATCH

Edits the Lumin Repositories configuration. Repositories that become enabled are synchronized to Lumin. Synchronization continues for new data from scan results as long as the repository remains enabled.

NOTE: Only IPv4 and Agent Repositories are supported
Request Parameters

Expand
{
	"repositories" : [
		{
			"repID": <string>,
			"enabledForIOSync": <string> "false" | "true"
		},...
	] DEFAULT []
}
Example Response
Expand
{
	"type": "regular",
	"response": {
		"2" : {
			"firstSyncTime" : "1573843474",
			"lastSyncSuccess" : "1573843474",
			"lastSyncFailure" : "-1",
			"details" : ""
		},
		"3" : {
			"firstSyncTime" : "1573843433",
			"lastSyncSuccess" : "1573843433",
			"lastSyncFailure" : "-1",
			"details" : ""
		}
		"6" : {
			"firstSyncTime" : "1573843479",
			"lastSyncSuccess" : "1573843479",
			"lastSyncFailure" : "-1",
			"details" : ""
		}
		"11" : {
			"firstSyncTime" : "1573843468",
			"lastSyncSuccess" : "1573843468",
			"lastSyncFailure" : "-1",
			"details" : ""
		}
	},
	"error_code": 0,
	"error_msg": "",
	"warnings": [],
	"timestamp": 1572462204
}

/lumin/assets

Methods
PATCH

Edits the Lumin Assets configuration. Enabled assets are synchronized to Lumin immediately.  Assets are then scheduled to synchronize to Lumin daily at either a random off hours time that is generated automatically or a custom time specified by the user.

NOTE #1: Only static and dynamic Assets are supported.
NOTE #2: Only Assets from the full access group are supported.
Request Parameters
Expand
{
	"assets" : [
		{
			"orgID": <string>,
			"assetID": <string>,
			"enabledForIOSync": <string> "false" | "true"
		},...
	] DEFAULT [],
	"schedule" : {
		"type" : "ical" <string> DEFAULT "ical",
		"start" : <string> (This value takes the iCal format) | "auto" DEFAULT "auto"
	}
}
Example Response
Expand
{
	"type": "regular",
	"response": "",
	"error_code": 0,
	"error_msg": "",
	"warnings": [],
	"timestamp": 1572462204
}

/lumin/assets/schedule

Methods
GET

Gets the schedule for daily synchronization of Assets to Lumin.

Request Parameters

None

Example Response
Expand
{
	"type" : "regular",
	"response" : {
		"id" : "8",
		"type" : "ical",
		"start" : "TZID=America\/New_York:20200305T230000",
		"repeatRule" : "FREQ=DAILY;INTERVAL=1",
		"nextRun" : 1583467200,
		"autoGenerated" : "true"
	},
	"error_code" : 0,
	"error_msg" : "",
	"warnings" : (Array),
	"timestamp" : 1583349312
}

/lumin/metrics

GET

Gets the Lumin metrics for cyber exposure score and assessment maturity grade and associated deltas showing the changes from the previous day's calculations.

Request Parameters

None

Example Response
Expand
{
	"type" : "regular",
	"response" : {
		"ioCyberExposureScore" : "541",
		"ioAssessmentMaturityGrade" : "50",
		"ioCyberExposureScoreDelta" : "71",
		"ioAssessmentMaturityGradeDelta" : "-20",
		"ioImportHostname" : "cloud.tenable.com"
	},
	"error_code" : 0,
	"error_msg" : "",
	"warnings" : (Array),
	"timestamp" : 1593098664
}

/lumin/test

GET

Tests the connection to Lumin.  The connection status returned can be one of the following:

  • 0 - connection was successful
  • 1 - connection failed
  • 2 - connection was successful, but Lumin is not enabled
  • 3 - connection was successful, Lumin is enabled, but the Lumin license has expired
  • 4 - connection was successful, but the IO container license has expired
Request Parameters

None

Example Response
Expand
{
	"type" : "regular",
	"response" : {
		"ioConnectionStatus" : "0"
	},
	"error_code" : 0,
	"error_msg" : "",
	"warnings" : (Array),
	"timestamp" : 1593098664
}