Vulnerability Data - VulnerabilityContainer Retrieve, Update, and Delete Methods

URI

https://164.99.19.131:8443/SentinelRESTServices/objects/vulnerability-container/{Id}

Supported Methods

GET
PUT
DELETE
GET

Authentication

Authentication Types
Sentinel Permissions Needed

Supported Formats

Response

URL Parameters

None.

Success Codes

Fault Codes

Response Data

Object type: vulnerability-container
An Vulnerability Container object contains information about enterprise vulnerabilities.
FieldDescription
eventsThe list of VulnerabilityEventData objects used to locate vulnerabilities when executing an vulnerability report. Definition
idUnique Identifier.
metaThe metadata for an object, including the object type name and the URL reference to the object. Definition
scannersList of vulnerability scanners from an executed vulnerability report. Definition
useEventTimeFlag to use current time or event time to determine which scanner to use.
Object type: meta
The metadata for an object, including the object type name and the URL reference to the object.
FieldDescription
@hrefThe URL reference to the object.
typeThe name of the object type
Object type: vulnerability-event-data
A Vulnerability Event Data object contains event information required to search for vulnerabilities in the system such as the customer name, IP address as well as event IDs and event times.
FieldDescription
customer-nameSearch for vulnerabilities from a specific customer.
ipSearch for vulnerabilities from a specific IP address.
timeUsed to find vulnerabilities associated with a given event ID and time.
uuidUsed to find vulnerabilities associated with a given event ID and time.
Object type: vulnerability-scanner
Represents a scan of enterprise assets for vulnerabilities.
FieldDescription
product-nameName of the product line of which this scanner is a member; if you don't set this, the Collector product name will be used.
product-versionThe version of the scanner product.
resourcesA list of vulnerability resources associated with this scan. Definition
scanner-instanceNeeds description.
scanner-typeThe type of scanner; currently hard-coded to 'VULN'.
vendorName of the vendor who manufactures this scanner; if you don't set this, the Collector vendor name will be used.

Sample Request

GET https://164.99.19.131:8443/SentinelRESTServices/objects/vulnerability-container/Wildebeest
Sample Response for application/json
Status: 200
{
   "meta":{
      "type":"vulnerability-container",
      "@href":"https://164.99.19.131:8443/SentinelRESTServices/objects/vulnerability-container/Wildebeest"
   },
   "id":"Wildebeest",
   "useEventTime":true,
   "events":[
      {
         "time":"2012-04-25T13:33:44.547Z",
         "uuid":"79600390-9B73-102E-A3E2-001676E4A757",
         "customer-name":"Company A",
         "ip":"137.65.2.12"
      }
   ],
   "scanners":[
      {
         "product-name":"Wildebeest",
         "vendor":"Nessus",
         "product-version":"Wildebeest",
         "scanner-instance":"Wildebeest",
         "scanner-type":"Wildebeest",
         "resources":[
            {
               "criticality":1,
               "location":"Building A",
               "department":"HR",
               "regulation":"Wildebeest",
               "hostname":"hr1.company.com",
               "op-env":"Wildebeest",
               "scanner-id":"79600390-9B73-102E-A3E2-001676E4A757",
               "regulation-rating":"Wildebeest",
               "business-system":"Wildebeest",
               "ip":"137.1.2.3",
               "vulnerabilities":[
                  {
                     "summary":"Wildebeest",
                     "module":"Wildebeest",
                     "computed-severity":42,
                     "app-protocol":"Wildebeest",
                     "assigned-severity":42,
                     "scanned-app-ver":"Wildebeest",
                     "port-number":523,
                     "network-protocol":42,
                     "detected-os":"SLES 11.2",
                     "solution":"Block access to port 523.",
                     "user-name":"Wildebeest",
                     "rsrc-id":"79600390-9B73-102E-A3E2-001676E4A757",
                     "scanned-app":"Wildebeest",
                     "user-domain":"Wildebeest",
                     "port-name":"Wildebeest",
                     "detected-os-ver":"1.0.1",
                     "name":"SMTP Port Access",
                     "scanner-classification":"Wildebeest",
                     "end-effective-date":"2012-04-25T13:33:44.547Z",
                     "taxonomy":"Wildebeest",
                     "begin-effective-date":"2012-04-25T13:33:44.547Z",
                     "port-reference":{
                        "protocol-number":42,
                        "description":"Wildebeest",
                        "keyword":"Wildebeest",
                        "port-number":42,
                        "protocol-reference":{
                           "description":"Wildebeest",
                           "keyword":"Wildebeest",
                           "number":42
                        }
                     },
                     "vulnerability-info":[
                        {
                           "vuln-id":"79600390-9B73-102E-A3E2-001676E4A757",
                           "value":"Wildebeest",
                           "type":"Wildebeest"
                        }
                     ],
                     "vulnerability-codes":[
                        {
                           "vuln-id":"79600390-9B73-102E-A3E2-001676E4A757",
                           "value":"Wildebeest",
                           "type":"Wildebeest",
                           "url":"Wildebeest"
                        }
                     ],
                     "protocol-reference":{
                        "description":"Wildebeest",
                        "keyword":"Wildebeest",
                        "number":42
                     }
                  }
               ]
            }
         ]
      }
   ]
}
PUT

Authentication

Authentication Types
Sentinel Permissions Needed

Supported Formats

Request

URL Parameters

None.

Success Codes

Fault Codes

Request Data

Object type: vulnerability-container
An Vulnerability Container object contains information about enterprise vulnerabilities.
FieldRequiredDescription
eventsfalseThe list of VulnerabilityEventData objects used to locate vulnerabilities when executing an vulnerability report. Definition
idfalseUnique Identifier.
scannersfalseList of vulnerability scanners from an executed vulnerability report. Definition
useEventTimefalseFlag to use current time or event time to determine which scanner to use.

Object type: meta
The metadata for an object, including the object type name and the URL reference to the object.
FieldRequiredDescription
@hreffalseThe URL reference to the object.
typefalseThe name of the object type

Object type: vulnerability-event-data
A Vulnerability Event Data object contains event information required to search for vulnerabilities in the system such as the customer name, IP address as well as event IDs and event times.
FieldRequiredDescription
customer-namefalseSearch for vulnerabilities from a specific customer.
ipfalseSearch for vulnerabilities from a specific IP address.
timefalseUsed to find vulnerabilities associated with a given event ID and time.
uuidfalseUsed to find vulnerabilities associated with a given event ID and time.

Object type: vulnerability-scanner
Represents a scan of enterprise assets for vulnerabilities.
FieldRequiredDescription
product-namefalseName of the product line of which this scanner is a member; if you don't set this, the Collector product name will be used.
product-versionfalseThe version of the scanner product.
resourcesfalseA list of vulnerability resources associated with this scan. Definition
scanner-instancefalseNeeds description.
scanner-typefalseThe type of scanner; currently hard-coded to 'VULN'.
vendorfalseName of the vendor who manufactures this scanner; if you don't set this, the Collector vendor name will be used.

Sample Request

PUT https://164.99.19.131:8443/SentinelRESTServices/objects/vulnerability-container/Wildebeest
{
   "id":"Wildebeest",
   "useEventTime":true,
   "events":[
      {
         "time":"2012-04-25T13:33:44.548Z",
         "uuid":"79600390-9B73-102E-A3E2-001676E4A757",
         "customer-name":"Company A",
         "ip":"137.65.2.12"
      }
   ],
   "scanners":[
      {
         "product-name":"Wildebeest",
         "vendor":"Nessus",
         "product-version":"Wildebeest",
         "scanner-instance":"Wildebeest",
         "scanner-type":"Wildebeest",
         "resources":[
            {
               "criticality":1,
               "location":"Building A",
               "department":"HR",
               "regulation":"Wildebeest",
               "hostname":"hr1.company.com",
               "op-env":"Wildebeest",
               "scanner-id":"79600390-9B73-102E-A3E2-001676E4A757",
               "regulation-rating":"Wildebeest",
               "business-system":"Wildebeest",
               "ip":"137.1.2.3",
               "vulnerabilities":[
                  {
                     "summary":"Wildebeest",
                     "module":"Wildebeest",
                     "computed-severity":42,
                     "app-protocol":"Wildebeest",
                     "assigned-severity":42,
                     "scanned-app-ver":"Wildebeest",
                     "port-number":523,
                     "network-protocol":42,
                     "detected-os":"SLES 11.2",
                     "solution":"Block access to port 523.",
                     "user-name":"Wildebeest",
                     "rsrc-id":"79600390-9B73-102E-A3E2-001676E4A757",
                     "scanned-app":"Wildebeest",
                     "user-domain":"Wildebeest",
                     "port-name":"Wildebeest",
                     "detected-os-ver":"1.0.1",
                     "name":"SMTP Port Access",
                     "scanner-classification":"Wildebeest",
                     "end-effective-date":"2012-04-25T13:33:44.548Z",
                     "taxonomy":"Wildebeest",
                     "begin-effective-date":"2012-04-25T13:33:44.548Z",
                     "port-reference":{
                        "protocol-number":42,
                        "description":"Wildebeest",
                        "keyword":"Wildebeest",
                        "port-number":42,
                        "protocol-reference":{
                           "description":"Wildebeest",
                           "keyword":"Wildebeest",
                           "number":42
                        }
                     },
                     "vulnerability-info":[
                        {
                           "vuln-id":"79600390-9B73-102E-A3E2-001676E4A757",
                           "value":"Wildebeest",
                           "type":"Wildebeest"
                        }
                     ],
                     "vulnerability-codes":[
                        {
                           "vuln-id":"79600390-9B73-102E-A3E2-001676E4A757",
                           "value":"Wildebeest",
                           "type":"Wildebeest",
                           "url":"Wildebeest"
                        }
                     ],
                     "protocol-reference":{
                        "description":"Wildebeest",
                        "keyword":"Wildebeest",
                        "number":42
                     }
                  }
               ]
            }
         ]
      }
   ]
}
Sample Response for application/json
Status: 200

DELETE

Authentication

Authentication Types
Sentinel Permissions Needed

URL Parameters

None.

Success Codes

Fault Codes

Sample Request

DELETE https://164.99.19.131:8443/SentinelRESTServices/objects/vulnerability-container/Wildebeest