SecurityCenter API: Job

/job

Methods
GET

Gets the list of Jobs across the application and all Organizations.

Fields Parameter
Expand

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

    ?fields=<field>,...

Allowed Fields

*id
**organization
**type
**status
objectID
initiator
targetedTime
startTime
pid
params
priority
errorCode
attemptNumber
dependentJobID
immediateJob

Legend

* = always comes back
** = comes back if fields list not specified on GET all

Example Response
Expand
{
	"type" : "regular",
	"response" : [
		{
			"id" : "387413",
			"type" : "repositorySnapshot",
			"status" : "scheduled",
			"organization" : {
				"id" : -1,
				"name" : "",
				"description" : ""
			}
		},
		{
			"id" : "387439",
			"type" : "appStatus",
			"status" : "scheduled",
			"organization" : {
				"id" : -1,
				"name" : "",
				"description" : ""
			}
		},
		{
			"id" : "387440",
			"type" : "licenseReport",
			"status" : "scheduled",
			"organization" : {
				"id" : -1,
				"name" : "",
				"description" : ""
			}
		},
		{
			"id" : "387444",
			"type" : "flushAllVulns",
			"status" : "scheduled",
			"orgID" : "0"
		},
		{
			"id" : "387448",
			"type" : "nightlyCleanup",
			"status" : "scheduled",
			"organization" : {
				"id" : -1,
				"name" : "",
				"description" : ""
			}
		},
		{
			"id" : "387497",
			"type" : "updateAllLDAPAssets",
			"status" : "scheduled",
			"organization" : {
				"id" : -1,
				"name" : "",
				"description" : ""
			}
		},
		{
			"id" : "387503",
			"type" : "updateAllDNSAssets",
			"status" : "scheduled",
			"organization" : {
				"id" : -1,
				"name" : "",
				"description" : ""
			}
		},
		{
			"id" : "387520",
			"type" : "feedUpdate",
			"status" : "scheduled",
			"organization" : {
				"id" : -1,
				"name" : "",
				"description" : ""
			}
		},
		{
			"id" : "387521",
			"type" : "lcePluginUpdate",
			"status" : "scheduled",
			"organization" : {
				"id" : -1,
				"name" : "",
				"description" : ""
			}
		},
		{
			"id" : "387529",
			"type" : "updateIDSCorrelations",
			"status" : "scheduled",
			"organization" : {
				"id" : -1,
				"name" : "",
				"description" : ""
			}
		},
		{
			"id" : "387540",
			"type" : "passivePluginUpdate",
			"status" : "scheduled",
			"organization" : {
				"id" : -1,
				"name" : "",
				"description" : ""
			}
		},
		{
			"id" : "387552",
			"type" : "pluginUpdate",
			"status" : "scheduled",
			"organization" : {
				"id" : -1,
				"name" : "",
				"description" : ""
			}
		},
		{
			"id" : "387563",
			"type" : "updateIDSSignatures",
			"status" : "scheduled",
			"organization" : {
				"id" : -1,
				"name" : "",
				"description" : ""
			}
		},
		{
			"id" : "387783",
			"type" : "expireAcceptedRisk",
			"status" : "scheduled",
			"organization" : {
				"id" : -1,
				"name" : "",
				"description" : ""
			}
		},
		{
			"id" : "387790",
			"type" : "updateLCEStatus",
			"status" : "scheduled",
			"organization" : {
				"id" : -1,
				"name" : "",
				"description" : ""
			}
		},
		{
			"id" : "387791",
			"type" : "updateLCETypes",
			"status" : "scheduled",
			"organization" : {
				"id" : -1,
				"name" : "",
				"description" : ""
			}
		},
		{
			"id" : "387792",
			"type" : "updateLCESilos",
			"status" : "scheduled",
			"organization" : {
				"id" : -1,
				"name" : "",
				"description" : ""
			}
		},
		{
			"id" : "387793",
			"type" : "refreshScannerStatus",
			"status" : "scheduled",
			"organization" : {
				"id" : -1,
				"name" : "",
				"description" : ""
			}
		}
	],
	"error_code" : 0,
	"error_msg" : "",
	"warnings" : [],
	"timestamp" : 1425331792
}

/job/{id}

Methods
GET

Gets the Job 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
 **organization
**type
**status
objectID
initiator
targetedTime
startTime
pid
params
priority
errorCode
attemptNumber
dependentJobID
immediateJob

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" : "387413",
		"type" : "repositorySnapshot",
		"objectID" : "-1",
		"status" : "scheduled",
		"organization" : {
			"id" : -1,
			"name" : "",
			"description" : ""
		},
		"initiator" : {
			"id" : "1",
			"username" : "admin",
			"firstname" : "Admin",
			"lastname" : "User"
		},
		"targetedTime" : "1425355200",
		"startTime" : "-1",
		"pid" : "-1",
		"params" : "a:0:{}",
		"priority" : "5",
		"errorCode" : "0",
		"attemptNumber" : "1",
		"dependentJobID" : "-1",
		"immediateJob" : "false"
	},
	"error_code" : 0,
	"error_msg" : "",
	"warnings" : [],
	"timestamp" : 1425332851
} 

/job/{id}/kill

Methods
POST

Kills the Job associated with {id}, depending on access.

Request Parameters

None

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