API Documentation
AISpectra
<GET> Job Status Details
2 min
get /api/ais/v1 5/job status detailed tab examples url https api aws boschaishield com prod api ais v1 5 job status detailed name job status details method get request pathparameters name job id kind required type string description enter uniquely created job id received during model analysis children 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 key bodydataparameters formdataparameters results languages id kc2y4qjqrpau4tyk2ivhe code 200 ok returns a json object containing the job details for every stage of vulnerability analysis defense generation n n language 200 customlabel id wtbayihuwetawq1mkfitv code 400 bad request error 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 ka pbmspjxu4s2kfhdbrg language 403 code 403 forbidden 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 customlabel id d8lh0hkideii7etzji3 h language 412 code 412 precondition failed 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 customlabel id q44se4fmkwnu5gm0jxlik language 429 code 429 too many requests 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 customlabel selectedlanguageid q44se4fmkwnu5gm0jxlik examples languages id qikk1kg ngzgcerysfit0 language python code import requests n njobid enter job id n nurl https api aws boschaishield com prod api ais v1 5 job status detailed?job id jobid n npayload nheaders n x api key n org id n n nresponse requests request get url headers headers data payload n nprint response text customlabel id fmfljeogjrkha6ngbcdr9 language curl code jobid enter job id ; ncurl location request get https api aws boschaishield com prod api ais v1 5 job status detailed?job id jobid n header accept application json n header x api key n header org id customlabel id osl7834txcdl3iokkfaqf language nodejs code var request require request ; n njobid enter job id n nvar options n method get n url https api aws boschaishield com prod api ais v1 5 job status detailed?job id jobid 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 hbk4tno1uyud 8ijn06ii 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 n nfetch https api aws boschaishield com prod api ais v1 5 job status detailed?job id jobid requestoptions n then response response text n then result console log result n catch error console log error error ; customlabel selectedlanguageid hbk4tno1uyud 8ijn06ii description job status detail api help you track progress of your active job id currentnewparameter label path parameter value pathparameters job id enter the job id you have recevied during the model analysis to get the progress of the given job id 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