Scans

Manage Scans

Put Scanning Results

PUThttps://app.aquilax.ai/api/v1/{organization_id}/scan/{scan_id}/results

Authorization

Personal Access Token

Path parameters

organization_id*Organization Id

scan_id*Scan Id

Body

application/json

scanner*Scanner

findingsFindings

exec_timeExec Time

numbernull

Response

200422

Successful Response

Body

application/json

any

Request

JavaScriptCurlPython

const response = await fetch('https://app.aquilax.ai/api/v1/{organization_id}/scan/{scan_id}/results', {
    method: 'PUT',
    headers: {
      "Content-Type": "application/json"
    },
    body: JSON.stringify({
      "scanner": "text"
    }),
});
const data = await response.json();

Response

422

{
  "detail": "text"
}

Put Metadata Results

PUThttps://app.aquilax.ai/api/v1/{organization_id}/scan/{scan_id}/metadata

Authorization

Personal Access Token

Path parameters

organization_id*Organization Id

scan_id*Scan Id

Response

200422

Successful Response

Body

application/json

any

Request

JavaScriptCurlPython

const response = await fetch('https://app.aquilax.ai/api/v1/{organization_id}/scan/{scan_id}/metadata', {
    method: 'PUT',
    headers: {},
});
const data = await response.json();

Response

422

{
  "detail": "text"
}

Put Scan Stage

PUThttps://app.aquilax.ai/api/v1/{organization_id}/scan/{scan_id}/status/{new_status}

Authorization

Personal Access Token

Path parameters

organization_id*Organization Id

scan_id*Scan Id

new_status*New Status

Response

200422

Successful Response

Body

application/json

any

Request

JavaScriptCurlPython

const response = await fetch('https://app.aquilax.ai/api/v1/{organization_id}/scan/{scan_id}/status/{new_status}', {
    method: 'PUT',
    headers: {},
});
const data = await response.json();

Response

422

{
  "detail": "text"
}

Get Scans Analytics

GEThttps://app.aquilax.ai/api/v1/organization/{org_id}/scans-analytics

Authorization

Personal Access Token

Path parameters

org_id*Org Id

Response

200422

Successful Response

Body

application/json

any

Request

JavaScriptCurlPython

const response = await fetch('https://app.aquilax.ai/api/v1/organization/{org_id}/scans-analytics', {
    method: 'GET',
    headers: {},
});
const data = await response.json();

Response

422

{
  "detail": "text"
}

Get Scan

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.

GEThttps://app.aquilax.ai/api/v1/organization/{org_id}/group/{group_id}/project/{project_id}/scan/{scan_id}

Authorization

Personal Access Token

Path parameters

org_id*Org Id

group_id*Group Id

project_id*Project Id

scan_id*Scan Id

Query parameters

Response

200422

Successful Response

Body

application/json

any

Request

JavaScriptCurlPython

const response = await fetch('https://app.aquilax.ai/api/v1/organization/{org_id}/group/{group_id}/project/{project_id}/scan/{scan_id}', {
    method: 'GET',
    headers: {},
});
const data = await response.json();

Response

422

{
  "detail": "text"
}

Delete Scan

This API endpoint allows users to delete a specific scan within an organization. By providing the organization ID, group ID, project ID, and scan ID, users can remove the specified scan. The endpoint returns a success message upon successful deletion of the scan. In case of an error, the endpoint raises an exception with an routerropriate error message.

DELETEhttps://app.aquilax.ai/api/v1/organization/{org_id}/group/{group_id}/project/{project_id}/scan/{scan_id}

Authorization

Personal Access Token

Path parameters

org_id*Org Id

group_id*Group Id

project_id*Project Id

scan_id*Scan Id

Response

200422

Successful Response

Body

application/json

any

Request

JavaScriptCurlPython

const response = await fetch('https://app.aquilax.ai/api/v1/organization/{org_id}/group/{group_id}/project/{project_id}/scan/{scan_id}', {
    method: 'DELETE',
    headers: {},
});
const data = await response.json();

Response

422

{
  "detail": "text"
}

Get Filtered Scans

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

projects: List[str] = Query(None) - A list of project IDs to filter the scans

limit: int = Query(50, ge=1) - The number of scans to be displayed per page

page: int = Query(1, ge=1) - The page number to be displayed

GEThttps://app.aquilax.ai/api/v1/organization/{org_id}/filtered-scans

Authorization

Personal Access Token

Path parameters

org_id*Org Id

Query parameters

Response

200422

Successful Response

Body

application/json

any

Request

JavaScriptCurlPython

const response = await fetch('https://app.aquilax.ai/api/v1/organization/{org_id}/filtered-scans', {
    method: 'GET',
    headers: {},
});
const data = await response.json();

Response

422

{
  "detail": "text"
}

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.

GEThttps://app.aquilax.ai/api/v1/organization/{org_id}/group/{group_id}/project/{project_id}/scans

Authorization

Personal Access Token

Path parameters

org_id*Org Id

group_id*Group Id

project_id*Project Id

Query parameters

Response

200422

Successful Response

Body

application/json

any

Request

JavaScriptCurlPython

const response = await fetch('https://app.aquilax.ai/api/v1/organization/{org_id}/group/{group_id}/project/{project_id}/scans', {
    method: 'GET',
    headers: {},
});
const data = await response.json();

Response

422

{
  "detail": "text"
}

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.

POSThttps://app.aquilax.ai/api/v1/organization/{org_id}/group/{group_id}/scan

Authorization

Personal Access Token

Path parameters

org_id*Org Id

group_id*Group Id

Body

application/json

git_uri*Git Uri

Pattern: ^(((https|http):\/\/)|(git@))[a-zA-Z0-9\.:\/_-]{1,250}$

termsTerms

booleannull

scanners*Scanners

access_tokenAccess Token

stringnull

installation_idInstallation Id

integernull

publicPublic

booleannull

frequency*Frequency

Pattern: ^(((((\d+,)+\d+|(\d+(\/|-|#)\d+)|\d+L?|\*(\/\d+)?|L(-\d+)?|\?|[A-Z]{3}(-[A-Z]{3})?) ?){5,7}))|(Once)|(Secondly)|(Hourly)|(Daily)|(Weekly)|(Monthly)$

tagsTags

array of stringnull

branchBranch

stringnull

Response

200422

Successful Response

Body

application/json

any

Request

JavaScriptCurlPython

const response = await fetch('https://app.aquilax.ai/api/v1/organization/{org_id}/group/{group_id}/scan', {
    method: 'POST',
    headers: {
      "Content-Type": "application/json"
    },
    body: JSON.stringify({
      "git_uri": "text",
      "scanners": {},
      "frequency": "text"
    }),
});
const data = await response.json();

Response

422

{
  "detail": "text"
}

Get Projects

GEThttps://app.aquilax.ai/api/v1/organization/{org_id}/group/{group_id}/project

Authorization

Personal Access Token

Path parameters

group_id*Group Id

org_id*Org Id

Query parameters

Response

200422

Successful Response

Body

application/json

any

Request

JavaScriptCurlPython

const response = await fetch('https://app.aquilax.ai/api/v1/organization/{org_id}/group/{group_id}/project', {
    method: 'GET',
    headers: {},
});
const data = await response.json();

Response

422

{
  "detail": "text"
}