Scans

Manage Scans

New Scan

This API endpoint allows users to create a new scan within an organization. By providing the organization ID and a scan object containing the scan details, users can initiate a new scan. The endpoint returns a JSON object containing the scan ID and project ID upon successful creation of the scan. In case of an error, the endpoint raises an exception with an routerropriate error message.

post

/api/v1/organization/{org_id}/group/{group_id}/scan

Authorizations
Path parameters
org_idOrg Idrequired
group_idGroup Idrequired
Body
git_uriGit Urirequired
Pattern: ^(((https|http):\/\/)|(git@))[a-zA-Z0-9\.:\/_-]{1,250}$
scannersScannersrequired
termsTerms
access_tokenAccess Token
installation_idInstallation Id
publicPublic
frequencyFrequency
branchBranch
tagsTags
Responses
curl -L \
  --request POST \
  --url 'https://aquilax.ai/api/v1/organization/{org_id}/group/{group_id}/scan' \
  --header 'X-AX-KEY: YOUR_API_KEY' \
  --header 'Content-Type: application/json' \
  --data '{"git_uri":"text","scanners":{"secret_scanner":false,"pii_scanner":false,"iac_scanner":false,"sast_scanner":false,"sca_scanner":false,"container_scanner":false,"compliance_scanner":false,"malware_scanner":false,"api_scanner":false,"image_scanner":false},"terms":false,"public":true,"tags":[]}'

No body

Scan Pdf Report

This API endpoint allows users to generate a PDF report for a specific scan within an organization. By providing the organization ID and scan ID, users can generate a PDF report for the specified scan. The endpoint returns a JSON object containing the report details. If the report is not found, the endpoint returns an empty JSON object.

get

/api/v1/organization/{org_id}/scan/{scan_id}/report

Authorizations
Path parameters
org_idOrg Idrequired
scan_idScan Idrequired
Responses
curl -L \
  --url 'https://aquilax.ai/api/v1/organization/{org_id}/scan/{scan_id}/report' \
  --header 'X-AX-KEY: YOUR_API_KEY'

No body

Get Scans For Project

This API endpoint allows users to fetch a list of scans for a specific project within an organization. By providing the organization ID, group ID, and project ID, users can retrieve a list of scans associated with the specified project. The endpoint returns a JSON object containing the list of scans. If no scans are found, the endpoint returns an empty list.

get

/api/v1/organization/{org_id}/group/{group_id}/project/{project_id}/scans

Authorizations
Path parameters
org_idOrg Idrequired
group_idGroup Idrequired
project_idProject Idrequired
Query parameters
pagePage
limitLimit
Responses
curl -L \
  --url 'https://aquilax.ai/api/v1/organization/{org_id}/group/{group_id}/project/{project_id}/scans' \
  --header 'X-AX-KEY: YOUR_API_KEY'

No body

Get Scan By Id

This API endpoint allows users to fetch details of a specific scan within an organization. By providing the organization ID, group ID, project ID, and scan ID, users can retrieve the details of the specified scan. The endpoint returns a JSON object containing the scan details. If the scan is not found, the endpoint returns an empty JSON object.

get

/api/v1/organization/{org_id}/scan/{scan_id}

Authorizations
Path parameters
org_idOrg Idrequired
scan_idScan Idrequired
Query parameters
formatFormat
Responses
curl -L \
  --url 'https://aquilax.ai/api/v1/organization/{org_id}/scan/{scan_id}' \
  --header 'X-AX-KEY: YOUR_API_KEY'

No body

Last updated

Was this helpful?