Projects

View / Update and Manage Projects

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.

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

Authorization

Personal Access Token

Path parameters

project_id*Project Id

group_id*Group Id

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}/group/{group_id}/project/{project_id}', {
    method: 'DELETE',
    headers: {},
});
const data = await response.json();

Response

422

{
  "detail": "text"
}

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.

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

Authorization

Personal Access Token

Path parameters

project_id*Project Id

group_id*Group Id

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}/group/{group_id}/project/{project_id}', {
    method: 'GET',
    headers: {},
});
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"
}

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.

POSThttps://app.aquilax.ai/api/v1/organization/{org_id}/group/{group_id}/project/{project_id}/stop-scheduled-scan

Authorization

Personal Access Token

Path parameters

org_id*Org Id

group_id*Group Id

project_id*Project 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}/stop-scheduled-scan', {
    method: 'POST',
    headers: {},
});
const data = await response.json();

Response

422

{
  "detail": "text"
}

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.

POSThttps://app.aquilax.ai/api/v1/organization/{org_id}/group/{group_id}/project/{project_id}/start-scheduled-scan

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}/start-scheduled-scan?frequency=text', {
    method: 'POST',
    headers: {},
});
const data = await response.json();

Response

422

{
  "detail": "text"
}