<GET> Retrieve Artifacts
2 min
<Get> Retrieve the report and assets as part of the assessment /api/ais/v1.5/get_report
Report generation API helps generate defense ,vulnerability reports and attack samples. (vulnerability report, defense artifacts,attack_samples). For generating reports, there are three parameters:
Retrieve reports
GET
https://api.aws.boschaishield.com/prod/api/ais/v1.5/get_report
Header Parameters
- x-api-keystringrequiredDescription
- Org-idstringrequiredDescription
Body Parameters
- job_idstringrequiredDescription
- report_typestringrequiredDescription
- file_formatNumberrequiredDescription
python
import requests
jobID="<< Enter Job ID >>"
reportType="<< Enter Report Type >>"
fileFormat=" << Enter File Format >>"
url = "https://api.aws.boschaishield.com/prod/api/ais/v1.5/get_report?job_id="+jobID+"&report_type="+reportType+"&file_format="+fileFormat+""
payload = {}
headers = {
'Accept': 'application/json',
'x-api-key': '########################################',
'Org-Id': '####################################################################################################'
}
response = requests.request("GET", url, headers=headers, data=payload)
print(response.text)curl
jobID="<< Enter Job ID>>";
reportType="<< Enter Report Type>>";
curl --location 'https://api.aws.boschaishield.com/prod/api/ais/v1.5/get_report?job_id='${jobID}'&report_type='${reportType}'&file_format=2' \
--header 'Accept: application/json' \
--header 'x-api-key: ########################################' \
--header 'Org-Id: ####################################################################################################'nodejs
var request = require('request');
jobID = '<< Enter Job ID >>'
reportType = '<<Enter Report Type >>'
fileFormat='<< Enter File Format >>'
var options = {
'method': 'GET',
'url': 'https://api.aws.boschaishield.com/prod/api/ais/v1.5/get_report?job_id='+jobID+'&report_type='+reportType+'&file_format='+fileFormat+'',
'headers': {
'x-api-key': '########################################',
'Org-Id': '####################################################################################################'
}
};
request(options, function (error, response) {
if (error) throw new Error(error);
console.log(response.body);
});
javascript
var myHeaders = new Headers();
myHeaders.append("x-api-key", "########################################");
myHeaders.append("Org-Id", "####################################################################################################");
var requestOptions = {
method: 'GET',
headers: myHeaders,
redirect: 'follow'
};
jobID="<<Enter JOB ID >>"
reportType="<< Enter Report Type >>"
fileFormat="<< Enter File Format >>"
fetch("https://api.aws.boschaishield.com/prod/api/ais/v1.5/get_report?job_id="+jobID+"&report_type="+reportType+"&file_format="+fileFormat+"", requestOptions)
.then(response => response.text())
.then(result => console.log(result))
.catch(error => console.log('error', error));200
// Returns a JSON object containing the job details for every stage of vulnerability analysis & defense generation400
// Returns an error message if the application cannot or will not process the request due to something that is perceived to be a client error (for example, malformed request syntax, invalid request message framing, etc.)403
// Returns an error message if access to the target resource has been denied.(For example- if x-api-key value is incorrect or not given)412
// Returns an error message if access to the target resource has been denied. (For example- if any of the parameter value is incorrect or license has expired)429
// Returns an error message if the user has sent too many requests(example 15-20 requests in 1 seconds) in a given amount of time.- job_id: Uniquely created job_id received during model analysis
- report_type: parameter to define type of report to download. e.g vulnerability, defense and attack_samples)
- file_format: value between 0-4, 0 = all,2 = pdf, 3 = json
For using Nodejs sample code, install npm package request
Given ample code for python is tested for Python version 3.7
Given Sample code for nodejs and javascript is tested for Node V20LTS