Tenable Security Center API: Report Template

/reportTemplate

Methods
GET

Gets the list of Report Templates.

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
summary
category
definition
styleFamily
screenshotCount
enabled
minUpgradeVersion
templatePubTime
templateModTime
templateDefModTime
definitionModTime
createdTime
modifiedTime
tags
requirements

Legend

* = always comes back

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

NOTE #1: Pseudo Category "0" (recent) is currently not supported

NOTE #2: The searchString parameter takes in a space-separated set of keywords/phrases (in parenthesis) and builds a fuzzy match based on them. For excluding a keyword/phrase, is preceded by a '-'. Example: 

	"searchString" : "audit" -"SCAP" ..."

Parameters must be passed in as query string (as opposed to JSON) in the format of: /reportTemplate?categoryID="1"&... 

{
	"categoryID" : <number> "1" (Threat Detection & Vulnerability Assessments) | "2" (Monitoring) | "3" (Security Industry Trends) | "4" (Executive) | "5" "Compliance & Configuration Assessment) | "6" (Discovery & Detection) DEFAULT "" (All Categories),
	"searchString" : <string> (Search String Format. See NOTE#2) DEFAULT "",
	"startOffset" : <number> (Positive Integer) DEFAULT "0",
	"endOffset" : <number> (Integer > startOffset) DEFAULT NOT_SET (all results)
}
Example Response
Expand 
{
	"type" : "regular",
	"response" : [
		{
			"id" : "1",
			"name" : "FakedDataTemplate",
			"description" : "This is a faked data template for the testing of SC-19907"		},
		{
			"id" : "2",
			"name" : "FakedDataTemplate2",
			"description" : "This is a faked data template for the testing of SC-19907"		}
	],
	"error_code" : 0,
	"error_msg" : "",
	"warnings" : [],
	"timestamp" : 1412017247
}

/reportTemplate/{id}

Methods
GET

Gets the Report Template 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
summary
category
definition
styleFamily
screenshotCount
enabled
minUpgradeVersion
templatePubTime
templateModTime
templateDefModTime
definitionModTime
createdTime
modifiedTime
tags
requirements

Legend

* = always comes back

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

None

Example Response
Expand 
{
	"type" : "regular",
	"response" : {
		"id" : "1",
		"name" : "FakedDataTemplate",
		"description" : "This is a faked data template for the testing of SC-19907",
		"summary" : null,
		"definition" : null,
		"styleFamily" : "1",
		"screenshotCount" : "2",
		"enabled" : "true",
		"minUpgradeVersion" : null,
		"templatePubTime" : null,
		"templateModTime" : null,
		"templateDefModTime" : null,
		"definitionModTime" : null,
		"createdTime" : null,
		"modifiedTime" : null,
		"tags" : [
			"FakedTest1"		],
		"requirements" : [
			{
				"requirement" : "fakedReq1",
				"value" : "1"			},
			{
				"requirement" : "fakedReq2",
				"value" : null
			}
		],
		"category" : {
			"id" : "1",
			"name" : "Threat Detection & Vulnerability Assessments",
			"description" : "Aid with identifying vulnerabilities and potential threats."		}
	},
	"error_code" : 0,
	"error_msg" : "",
	"warnings" : [],
	"timestamp" : 1412017433
}

/reportTemplate/{templateID}/image/{sequenceID}

Methods
GET

Gets the Report Template image associated with template {templateID} and image {sequenceID}.

NOTE: This endpoint is handled before token validation.

Request Query Parameters

None

Example Response

None given. The response will be a raw png file containing the requested Report Template image.

/reportTemplate/categories

Methods
GET

Gets the list of Report Template categories

Request Query Parameters

None

Example Response
Expand 
{
	"type" : "regular",
	"response" : [
		{
			"id" : "1",
			"name" : "Threat Detection & Vulnerability Assessments",
			"description" : "Aid with identifying vulnerabilities and potential threats.",
			"count" : "71"		},
		{
			"id" : "2",
			"name" : "Monitoring",
			"description" : "Provide intrusion monitoring, alerting and analysis.",
			"count" : "36"		},
		{
			"id" : "3",
			"name" : "Security Industry Trends",
			"description" : "Influenced by trends, reports, and analysis from industry leaders.",
			"count" : "5"		},
		{
			"id" : "4",
			"name" : "Executive",
			"description" : "Provide operational insight and metrics geared towards executives.",
			"count" : "19"		},
		{
			"id" : "5",
			"name" : "Compliance & Configuration Assessment",
			"description" : "Aid with configuration, change and compliance management.",
			"count" : "57"		},
		{
			"id" : "6",
			"name" : "Discovery & Detection",
			"description" : "Aid in trust identification, rogue detection,and new device discovery.",
			"count" : "23"		}
	],
	"error_code" : 0,
	"error_msg" : "",
	"warnings" : [],
	"timestamp" : 1412091153
}