<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

Supply Chain Attacks

This api perform static assessment of files present in repos, local or s3 bucket for possible vulnerability

POST

https://api.aws.boschaishield.com/prod/api/ais/v1.5/supplychain

Header Parameters

x-api-keystringrequired
Description
Enter your API key
Org-Idstringrequired
Description
Enter your organization id

Body Parameters

repo_typeStringrequired
Description
The type of repository to scan (e.g., github, gitlab, bitbucket, huggingface, s3_bucket, azure_blob, gcp_storage).
repo_urlstring
Description
URL of the repository to be scanned.
branch_namestring
Description
Name of the branch in the repository to be scanned (e.g., main, dev).
depthInteger
Description
Number of recent commits to scan from the specified branch (e.g., depth: 10 scans the latest 10 commits).
usernamestring
Description
Optional username used for authenticating access to private repositories when required (e.g., GitHub, GitLab, Bitbucket, huggingface).
patstring
Description
Personal Access Token used for authenticating access to private repositories.
model_idstring
Description
Required if repo_type is file; identifier returned by the model ID generation API, used to locate the uploaded file for scanning.
aws_access_key_idstring
Description
AWS access key ID used to authenticate and access S3 buckets when repo_type is s3_bucket.
aws_secret_access_keystring
Description
AWS secret access key paired with aws_access_key_id for authenticating access to S3 resources.
regionstring
Description
The AWS region where the S3 bucket is hosted (e.g., us-east-1, ap-south-1).
bucket_namestring
Description
Required if repo_type is s3_bucket or gcp_storage; specifies the name of the cloud storage bucket to be scanned. Default : If no bucket name is provided, the bucket's under the provided credentials are auto-discovered and fully scanned.
azure_connection_stringstring
Description
Connection string used to authenticate and access Azure Blob Storage when repo_type is azure_blob.
container_namestring
Description
Name of the Azure Blob Storage container to be scanned; required when repo_type is azure_blob. Default : If no container name is provided, the container's under the provided credentials are auto-discovered and fully scanned.
service_account_json_fileobject
Description
File containing the JSON key for a GCP service account; required for authentication when repo_type is gcp_storage.

curl

curl --location 'https://api.aws.boschaishield.com/prod/api/ais/v1.5/supplychain' \
--header 'x-api-key: string' \
--header 'Org_id: string' \
--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"}

python

import requests

url = "https://api.aws.boschaishield.com/prod/api/ais/v1.5/supplychain"

payload = {"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"}
headers = {
   'x-api-key': 'string',
   'Org_id': 'string'
}

response = requests.request("POST", url, headers=headers, data=payload)

print(response.text)

200

// 200 OK: Returns a JSON object containing unique model ID and urls to upload required files.

401

// 401 Unauthorized: Returns an error message if the provided API key or Org-ID is invalid or expired.

400

// 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.)

412

// 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)