API Documentation
AISpectra
<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 { "tab" "examples", "url" "https //api aws boschaishield com/prod/api/ais/v1 5/get report", "name" "retrieve reports", "method" "get", "request" { "pathparameters" \[], "queryparameters" \[], "headerparameters" \[ { "kind" "required", "name" "x api key", "type" "string", "children" \[], "description" "enter your api key" }, { "kind" "required", "name" "org id", "type" "string", "children" \[], "description" "enter your organization id" } ], "bodydataparameters" \[ { "name" "job id", "kind" "required", "type" "string", "description" "enter uniquely created job id received during model analysis ", "children" \[] }, { "name" "report type", "kind" "required", "type" "string", "description" "you can generate different reports (vulnerability, defense and attack samples)", "children" \[] }, { "name" "file format", "kind" "required", "type" "number", "description" "0 4 values can be used to generate the report 0 = all, 2 = pdf, 3 = json", "children" \[] } ], "formdataparameters" \[] }, "results" { "languages" \[ { "id" "tzi4va5g2t21ms5ivnv4i", "code" "// returns a json object containing the job details for every stage of vulnerability analysis & defense generation", "language" "200", "customlabel" "" }, { "id" "kbovgngwgezftqzu6b3a ", "code" "// 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 )", "language" "400", "customlabel" "" }, { "id" "vgao3jwyzidvj8t0h3pjq", "code" "// 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)", "language" "403", "customlabel" "" }, { "id" " topujfmiegm14b7qesqy", "code" "// 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)", "language" "412", "customlabel" "" }, { "id" "phzjxhqtuaomecvlfiifi", "code" "// 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 ", "language" "429", "customlabel" "" } ], "selectedlanguageid" "kbovgngwgezftqzu6b3a " }, "examples" { "languages" \[ { "id" "lpx5xcm0t jbs1f5ym11s", "language" "python", "code" "import requests\n\njobid=\\"<< enter job id >>\\"\nreporttype=\\"<< enter report type >>\\"\nfileformat=\\" << enter file format >>\\"\n\nurl = \\"https //api aws boschaishield com/prod/api/ais/v1 5/get report?job id=\\"+jobid+\\"\&report type=\\"+reporttype+\\"\&file format=\\"+fileformat+\\"\\"\n\npayload = {}\nheaders = {\n 'accept' 'application/json',\n 'x api key' '########################################',\n 'org id' '####################################################################################################'\n}\n\nresponse = requests request(\\"get\\", url, headers=headers, data=payload)\n\nprint(response text)", "customlabel" "" }, { "id" "ibcoymi1mjkwyg0jwcgg5", "language" "curl", "code" "jobid=\\"<< enter job id>>\\";\nreporttype=\\"<< enter report type>>\\";\ncurl location 'https //api aws boschaishield com/prod/api/ais/v1 5/get report?job id='${jobid}'\&report type='${reporttype}'\&file format=2' \\\\\n header 'accept application/json' \\\\\n header 'x api key ########################################' \\\\\n header 'org id ####################################################################################################'", "customlabel" "" }, { "id" "yrviph54dlvhhf6vg2zuo", "language" "nodejs", "code" "var request = require('request');\n\njobid = '<< enter job id >>'\nreporttype = '<\<enter report type >>'\nfileformat='<< enter file format >>'\nvar options = {\n 'method' 'get',\n 'url' 'https //api aws boschaishield com/prod/api/ais/v1 5/get report?job id='+jobid+'\&report type='+reporttype+'\&file format='+fileformat+'',\n 'headers' {\n 'x api key' '########################################',\n 'org id' '####################################################################################################'\n }\n};\nrequest(options, function (error, response) {\n if (error) throw new error(error);\n console log(response body);\n});\n", "customlabel" "" }, { "id" "vrigveo83v9hrv9k ldc", "language" "javascript", "code" "var myheaders = new headers();\nmyheaders append(\\"x api key\\", \\"########################################\\");\nmyheaders append(\\"org id\\", \\"####################################################################################################\\");\n\nvar requestoptions = {\n method 'get',\n headers myheaders,\n redirect 'follow'\n};\n\njobid=\\"<\<enter job id >>\\"\nreporttype=\\"<< enter report type >>\\"\nfileformat=\\"<< enter file format >>\\"\n\nfetch(\\"https //api aws boschaishield com/prod/api/ais/v1 5/get report?job id=\\"+jobid+\\"\&report type=\\"+reporttype+\\"\&file format=\\"+fileformat+\\"\\", requestoptions)\n then(response => response text())\n then(result => console log(result))\n catch(error => console log('error', error));", "customlabel" "" } ], "selectedlanguageid" "lpx5xcm0t jbs1f5ym11s" }, "description" "", "currentnewparameter" { "label" "query parameter", "value" "queryparameters" } } 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