Projects

View / Update and Manage Projects

Update Project

This API endpoint allows users to update the details of an existing project within an organization. By providing the project ID, organization ID and a project object containing the updated project details, users can modify the project information. The endpoint returns a success message upon successful completion of the operation. In case of an error, the endpoint raises an exception with an routerropriate error message.

put

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

Authorizations

Path parameters

group_idGroup Idrequired

project_idProject Idrequired

org_idOrg Idrequired

Body

nameNamerequired

tagsTagsrequired

Responses

application/json

application/json

cURL

JavaScript

Python

HTTP

cURL

curl -L \
  --request PUT \
  --url 'https://aquilax.ai/api/v1/organization/{org_id}/group/{group_id}/project/{project_id}' \
  --header 'X-AX-KEY: YOUR_API_KEY' \
  --header 'Content-Type: application/json' \
  --data '{"name":"Demo Project","tags":"tag1"}'

200

422

200

No body

Successful Response

Delete Project

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

delete

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

Authorizations

Path parameters

project_idProject Idrequired

group_idGroup Idrequired

org_idOrg Idrequired

Responses

application/json

application/json

cURL

JavaScript

Python

HTTP

cURL

curl -L \
  --request DELETE \
  --url 'https://aquilax.ai/api/v1/organization/{org_id}/group/{group_id}/project/{project_id}' \
  --header 'X-AX-KEY: YOUR_API_KEY'

200

422

200

No body

Successful Response

Get Project

This API endpoint retrieves the details of a specific project within an organization. By providing the organization ID and project ID, users can fetch the project details. The endpoint returns a JSON object containing the project information. If the project is not found, the endpoint returns an error message.

get

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

Authorizations

Path parameters

project_idProject Idrequired

group_idGroup Idrequired

org_idOrg Idrequired

Responses

application/json

application/json

cURL

JavaScript

Python

HTTP

cURL

curl -L \
  --url 'https://aquilax.ai/api/v1/organization/{org_id}/group/{group_id}/project/{project_id}' \
  --header 'X-AX-KEY: YOUR_API_KEY'

200

422

200

No body

Successful Response

Get Projects

get

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

Authorizations

Path parameters

group_idGroup Idrequired

org_idOrg Idrequired

Query parameters

pagePage

limitLimit

Responses

application/json

application/json

cURL

JavaScript

Python

HTTP

cURL

curl -L \
  --url 'https://aquilax.ai/api/v1/organization/{org_id}/group/{group_id}/project' \
  --header 'X-AX-KEY: YOUR_API_KEY'

200

422

200

No body

Successful Response

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

application/json

application/json

cURL

JavaScript

Python

HTTP

cURL

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":[]}'

200

422

200

No body

Successful Response

Start Schedule

This API endpoint allows users to start a scheduled scan for a specific project within an organization. By providing the organization ID and project ID, users can start the scheduled scan for the project. The endpoint returns a JSON object containing a success message upon successful completion of the operation. In case of an error, the endpoint raises an exception with an routerropriate error message.

post

/api/v1/organization/{org_id}/group/{group_id}/project/{project_id}/start-scheduled-scan

Authorizations

Path parameters

org_idOrg Idrequired

group_idGroup Idrequired

project_idProject Idrequired

Query parameters

frequencyFrequencyrequired

Responses

application/json

application/json

cURL

JavaScript

Python

HTTP

cURL

curl -L \
  --request POST \
  --url 'https://aquilax.ai/api/v1/organization/{org_id}/group/{group_id}/project/{project_id}/start-scheduled-scan?frequency=text' \
  --header 'X-AX-KEY: YOUR_API_KEY'

200

422

200

No body

Successful Response

Stop Schedule

API endpoint to stop a scheduled scan for a specific project within an organization. It sends a request to the jobs.py server to remove the scheduled job.

post

/api/v1/organization/{org_id}/group/{group_id}/project/{project_id}/stop-scheduled-scan

Authorizations

Path parameters

org_idOrg Idrequired

group_idGroup Idrequired

project_idProject Idrequired

Responses

application/json

application/json

cURL

JavaScript

Python

HTTP

cURL

curl -L \
  --request POST \
  --url 'https://aquilax.ai/api/v1/organization/{org_id}/group/{group_id}/project/{project_id}/stop-scheduled-scan' \
  --header 'X-AX-KEY: YOUR_API_KEY'

200

422

200

No body

Successful Response