SecurityCenter API: ARC Template

/arcTemplate

Methods
GET

Gets the list of ARC 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
enabled
focusFilters
policyStatements
tags
requirements

category

minUpgradeVersion
templatePubTime
templateModTime
definitionModTime
createdTime
modifiedTime

Legend

* = always comes back

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

NOTE: 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: /arcTemplate?searchString=...

{
    "searchString" : <string> (Search String Format. See NOTE) DEFAULT ""
	"startOffset" : <number> (Positive Integer) DEFAULT "0",
	"endOffset" : <number> (Integer > startOffset) DEFAULT -1 (all results),
	"categoryID" : <number> DEFAULT -1 (all results)
}
Example Response
Expand
{
	"type" : "regular",
	"response" : [
		{
			"id" : "1",
			"name" : "AA Patching Policy",
			"description" : ""
		}
	],
	"error_code" : 0,
	"error_msg" : "",
	"warnings" : [],
	"timestamp" : 1415127035
}

/arcTemplate/{id}

Methods
GET

Gets the ARC 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
enabled
focusFilters
policyStatements
tags
requirements
category

minUpgradeVersion
templatePubTime
templateModTime
definitionModTime
createdTime
modifiedTime

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" : "Example Arc Template",
		"description" : "",
		"summary" : "",
		"enabled" : "true",
		"focusFilters" : [],
		"category" : {
			"id" : "1",
			"name" : "Compliance",
			"description" : ""
		},
		"policyStatements" : [
			{
				"label" : "Policy Statement 1",
				"baseFilters" : [
					{
						"filterName" : "ip",
						"operator" : "=",
						"value" : "192.168.1.1"
					}
				],
				"compliantFilters" : [
					{
						"filterName" : "baseCVSSScore",
						"operator" : "=",
						"value" : "2-3"
					}
				],
				"drilldownFilters" : [
					{
						"filterName" : "asset",
						"operator" : "=",
						"value" : {
						"template" : {
						"id" : "35",
						"name" : "Nessus Scanner",
						"description" : ""
						}
						}
					}
				],
				"baseStatus" : "0",
				"compliantStatus" : "0",
				"drilldownStatus" : "0",
				"conditionalName" : "hosts",
				"conditionalOperator" : "All",
				"conditionalValue" : "",
				"displayType" : "state",
				"result" : "",
				"resultOutput" : "{}",
				"queryType" : "vuln"
			}
		],
		"minUpgradeVersion" : null,
		"templatePubTime" : null,
		"templateModTime" : null,
		"definitionModTime" : null,
		"createdTime" : null,
		"modifiedTime" : null,
		"tags" : [],
		"requirements" : []
	},
	"error_code" : 0,
	"error_msg" : "",
	"warnings" : [],
	"timestamp" : 1415313873
}

/arcTemplate/{templateID}/image

Methods
GET

Gets the ARC Template image associated with template {templateID}

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 ARC Template image.

/arcTemplate/categories

Methods
GET

Gets the list of ARCTemplate categories

Request Query Parameters

None

Example Response
Expand
{
	"type" : "regular",
	"response" : [
		{
			"id" : "2",
			"name" : "Executive",
			"description" : "",
			"count" : "0",
			"status" : ""
		},
		{
			"id" : "1",
			"name" : "Compliance",
			"description" : "",
			"count" : "3",
			"status" : "new"
		}
	],
	"error_code" : 0,
	"error_msg" : "",
	"warnings" : [],
	"timestamp" : 1426007748
}