API Documentation
...
Model Scanner
<POST> Supply Chain Attacks
1 min
the below parameters are for supply chain attacks to know more about different input parameters and how to use api see ai/ml supply chain docid\ xso05koq um byw47j0ub tab examples url https api aws boschaishield com prod api ais v1 5 supplychain name supply chain attacks method post 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 description enter your organization id org id bodydataparameters name repo type kind required type string description the type of repository to scan e g github gitlab bitbucket huggingface s3 bucket azure blob gcp storage the type of repository to scan e g github gitlab bitbucket huggingface s3 bucket azure blob gcp storage name repo url kind optional type string description url of the repository to be scanned url of the repository to be scanned name branch name kind optional type string description name of the branch in the repository to be scanned e g main dev name of the branch in the repository to be scanned e g main dev name depth kind optional type integer description number of recent commits to scan from the specified branch e g depth 10 scans the latest 10 commits optional name username kind optional type string description optional username used for authenticating access to private repositories when required e g github gitlab bitbucket huggingface optional username used for authenticating access to private repositories when required e g github gitlab bitbucket huggingface name pat kind optional type string description personal access token used for authenticating access to private repositories personal access token used for authenticating access to private repositories name model id kind optional type string description required if repo type is file; identifier returned by the model id generation api used to locate the uploaded file for scanning required if repo type is file; identifier returned by the model id generation api used to locate the uploaded file for scanning name aws access key id kind optional type string description aws access key id used to authenticate and access s3 buckets when repo type is s3 bucket aws access key id used to authenticate and access s3 buckets when repo type is s3 bucket name aws secret access key kind optional type string description aws secret access key paired with aws access key id for authenticating access to s3 resources aws secret access key paired with aws access key id for authenticating access to s3 resources name region kind optional type string description the aws region where the s3 bucket is hosted e g us east 1 ap south 1 the aws region where the s3 bucket is hosted e g us east 1 ap south 1 name bucket name kind optional type string description required if repo type is s3 bucket or gcp storage; specifies the name of the cloud storage bucket to be scanned ndefault if no bucket name is provided the bucket s under the provided credentials are auto discovered and fully scanned required if repo type is s3 bucket or gcp storage; specifies the name of the cloud storage bucket to be scanned ndefault if no bucket name is provided the bucket s under the provided credentials are auto discovered and fully scanned name azure connection string kind optional type string description connection string used to authenticate and access azure blob storage when repo type is azure blob connection string used to authenticate and access azure blob storage when repo type is azure blob name container name kind optional type string description name of the azure blob storage container to be scanned; required when repo type is azure blob ndefault if no container name is provided the container s under the provided credentials are auto discovered and fully scanned n name of the azure blob storage container to be scanned; required when repo type is azure blob ndefault if no container name is provided the container s under the provided credentials are auto discovered and fully scanned n name service account json file kind optional type object description file containing the json key for a gcp service account; required for authentication when repo type is gcp storage file containing the json key for a gcp service account; required for authentication when repo type is gcp storage formdataparameters results languages id dl4hdcclth6dutou opbd code 200 ok returns a json object containing unique model id and urls to upload required files language 200 customlabel id z5ds opimhsxfewrtknkw language 401 code 401 unauthorized returns an error message if the provided api key or org id is invalid or expired customlabel id xjhl9zr5waz30f4gu2buz language 400 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 customlabel id exy7xhvpq ht16gzp2cna 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 selectedlanguageid exy7xhvpq ht16gzp2cna examples languages id 4nw1wnbd6npsuktvhukcc language curl code curl location https api aws boschaishield com prod api ais v1 5 supplychain n header x api key string n header org id string n data repo type string repo url string branch name string depth integer model id string aws access key id string aws secret access key string region string bucket name string customlabel id mv0gq6fc0vtao9owg4fqq language python code import requests n nurl https api aws boschaishield com prod api ais v1 5 supplychain n npayload repo type string repo url string branch name string depth integer model id string aws access key id string aws secret access key string region string bucket name string nheaders n x api key string n org id string n n nresponse requests request post url headers headers data payload n nprint response text n customlabel selectedlanguageid mv0gq6fc0vtao9owg4fqq description this api perform static assessment of files present in repos local or s3 bucket for possible vulnerability currentnewparameter label body parameter value bodydataparameters hastryitout false