API Guide

ProductSummary API

The ProductSummary API can be used to retrieve information about software installed in your environment.

ProductSummary contains both identified software and identified KB, for SAM view it's recommended to filter out the KB ("isCPE:true").

HTTP POST

URL

https://<hostname>:<port>/job-rest-service/job/search/<companyname>-<jobname>/ProductSummary

<hostname>: Azure hostname

<port>: Azure port

<companyname>: Customer's company name

<jobname>: Customer's jobname defined in Connect>

Header (JSON format)

Content-Type: application/json

Accept: application/json

X-MS-VERSION: v0.1.1

X-AD-Authorization: <azureToken>

Header (XML format)

Content-Type: application/xml

Accept: application/xml

X-MS-VERSION: v0.1.1

X-AD-Authorization: <azureToken>

Body (JSON format)

{

"pageNumber": <pageNumber>,

"pageSize": <pageSize>,

"criteria":{

"query": {

"bool": {

"must": [

<filter>

],

"must_not": [

<filter>

]

}

}

}

}


<pageNumber>: page number to retrieve

<pageSize>: number of results per page. The maximum is set to 200

<filter>: query's filter. Sample retrieve all un-patched vulnerabilities

{ "term": { "isCPE": "true" }}

{ "terms": { "cvss_Severity": ["Critical","High"] }}

Body (XML format)

<SearchArgs>

<pageNumber>[pageNumber]</pageNumber>

<pageSize>[pageSize]</pageSize>

<criteria>

{"query":{"bool":

{"must":[filter]},{"must_not":[filter]}

}}

</criteria>

</SearchArgs>


[pageNumber]: page number to retrieve

[pageSize]: number of results per page. The maximum is set to 200

[filter]: query's filter. Sample retrieve all un-patched vulnerabilities

{ "term": { "isCPE": "true" }}

{ "terms": { "cvss_Severity": ["Critical","High"] }}

Sample JSON results:

ProductSummary API

Pagination

The response above provide 3 key attributes for the pagination

  • pageNumber: current page returned
  • totalPage: total number of page
  • pageSize: size of each return page

Support

if you have questions or issues using the API, please contact us as support@fatstacks.tech