<GET> Retrieve Artifacts

2min

 <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:
GET
Request
Header Parameters
x-api-key
required
String
Enter your API key
Org-id
required
String
Enter your organization id
Body Parameters
job_id
required
String
Enter uniquely created job_id received during model analysis.
report_type
required
String
You can generate different reports (vulnerability, defense and attack_samples)
file_format
required
Number
0 - 4 values can be used to generate the report. 0 = all,  2 = pdf, 3 = json
Python
Curl
Node.js
JS
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)
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)
Responses
200
400
403
412
429
// 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.)
// 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.)
﻿
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 
﻿

Updated 20 Dec 2024

Did this page help you?

<GET> Job Status Details

<POST> Model Analysis