API Documentation

Retrieve project details

Retrieves detailed information about a specific project, including branch scan statistics and values.

GET<baseURL>/api/project

Query parameters

Response

200400

Successful response

Body

application/json

settingsobject

integrationsobject

schemaVersionstring

project_namestring

descriptionnullable string

versionnullable string

languagesarray of string

created_atstring (date-time)

tagsarray of string

total_locinteger

total_filesinteger

typestring

ownerstring

teamarray of string

created_bystring

scan_idsarray of string

isActiveboolean

analyticsobject

statestring

last_scan_timeinteger

is_repository_accessibleboolean

sast_severities_countobject

sca_issues_countobject

licenses_countobject

default_branchstring

branchesarray of object

Request

JavaScriptCurlPython

const response = await fetch('<baseURL>/api/project?key=text', {
    method: 'GET',
    headers: {},
});
const data = await response.json();

Response

200400

{
  "settings": {
    "analyse_settings": {
      "excluded_paths": "text",
      "sca": false,
      "sast": false,
      "license_detection": false,
      "default_policy": "text"
    },
    "monitoring_settings": {
      "post_scan_comment_sast_result": false,
      "create_pr_sca_new_issues": false,
      "create_pr_sca_backlog_issues": false,
      "assign_pr_sca": false,
      "assign_pr_sca_users": [
        "text"
      ],
      "push_event": false,
      "pull_request_event": false,
      "default_branch": "text",
      "webhook": {
        "active": false,
        "id": "text",
        "parameter": "text"
      }
    }
  },
  "integrations": {
    "azure": {
      "repoId": "text",
      "account": "text",
      "project": "text",
      "policy_id": "text",
      "type": "text",
      "branch": "text",
      "projectID": "text"
    },
    "github": {
      "repoId": "text",
      "account": "text",
      "policy_id": "text",
      "branch": "text",
      "url": "text",
      "type": "text"
    },
    "gitlab": {
      "projectID": "text",
      "account": "text",
      "policy_id": "text",
      "branch": "text",
      "url": "text",
      "type": "text"
    },
    "bitbucket": {
      "account": "text",
      "workspace": "text",
      "repository": "text",
      "projectKey": "text",
      "policy_id": "text",
      "branch": "text",
      "type": "text"
    },
    "git": {
      "url": "text",
      "branch": "text",
      "policy_id": "text"
    }
  },
  "schemaVersion": "text",
  "project_name": "text",
  "description": "text",
  "version": "text",
  "languages": [
    "text"
  ],
  "created_at": "2024-11-21T06:47:53.912Z",
  "tags": [
    "text"
  ],
  "type": "text",
  "owner": "text",
  "team": [
    "text"
  ],
  "created_by": "text",
  "scan_ids": [
    "text"
  ],
  "isActive": false,
  "analytics": {
    "issueTrend": [
      {
        "id": "text",
        "date": "2024-11-21T06:47:53.912Z",
        "issues": {}
      }
    ],
    "_id": "text"
  },
  "state": "text",
  "is_repository_accessible": false,
  "sast_severities_count": {},
  "sca_issues_count": {},
  "licenses_count": {},
  "default_branch": "text",
  "branches": [
    {
      "branch_name": "text",
      "scans": [
        "text"
      ]
    }
  ]
}

List projects

Retrieves a list of projects based on the provided parameters.

GET<baseURL>/api/projects

Query parameters

Response

200400

Successful response

Body

application/json

settingsobject

integrationsobject

schemaVersionstring

project_namestring

descriptionnullable string

versionnullable string

languagesarray of string

created_atstring (date-time)

tagsarray of string

total_locinteger

total_filesinteger

typestring

ownerstring

teamarray of string

created_bystring

scan_idsarray of string

isActiveboolean

analyticsobject

statestring

last_scan_timeinteger

last_scan_idstring

is_repository_accessibleboolean

sast_issues_countinteger

sca_issues_countinteger

licenses_countinteger

default_branchstring

Request

JavaScriptCurlPython

const response = await fetch('<baseURL>/api/projects', {
    method: 'GET',
    headers: {},
});
const data = await response.json();

Response

200400

[
  {
    "settings": {
      "analyse_settings": {
        "excluded_paths": "text",
        "sca": false,
        "sast": false,
        "license_detection": false,
        "default_policy": "text"
      },
      "monitoring_settings": {
        "post_scan_comment_sast_result": false,
        "create_pr_sca_new_issues": false,
        "create_pr_sca_backlog_issues": false,
        "assign_pr_sca": false,
        "assign_pr_sca_users": [
          "text"
        ],
        "push_event": false,
        "pull_request_event": false,
        "default_branch": "text",
        "webhook": {
          "active": false,
          "id": "text",
          "parameter": "text"
        }
      }
    },
    "integrations": {
      "azure": {
        "repoId": "text",
        "account": "text",
        "project": "text",
        "policy_id": "text",
        "type": "text",
        "branch": "text",
        "projectID": "text"
      },
      "github": {
        "repoId": "text",
        "account": "text",
        "policy_id": "text",
        "branch": "text",
        "url": "text",
        "type": "text"
      },
      "gitlab": {
        "projectID": "text",
        "account": "text",
        "policy_id": "text",
        "branch": "text",
        "url": "text",
        "type": "text"
      },
      "bitbucket": {
        "account": "text",
        "workspace": "text",
        "repository": "text",
        "projectKey": "text",
        "policy_id": "text",
        "branch": "text",
        "type": "text"
      },
      "git": {
        "url": "text",
        "branch": "text",
        "policy_id": "text"
      }
    },
    "schemaVersion": "text",
    "project_name": "text",
    "description": "text",
    "version": "text",
    "languages": [
      "text"
    ],
    "created_at": "2024-11-21T06:47:53.912Z",
    "tags": [
      "text"
    ],
    "type": "text",
    "owner": "text",
    "team": [
      "text"
    ],
    "created_by": "text",
    "scan_ids": [
      "text"
    ],
    "isActive": false,
    "analytics": {
      "issueTrend": [
        {
          "id": "text",
          "date": "2024-11-21T06:47:53.912Z",
          "issues": {}
        }
      ],
      "_id": "text"
    },
    "state": "text",
    "last_scan_id": "text",
    "is_repository_accessible": false,
    "default_branch": "text"
  }
]

Get scan status

Retrieve the status and details of a scan using its ID.

GET<baseURL>/api/scan/status/{scanId}

Path parameters

scanId*string

URL path to provide the scan ID.

Response

200400403404

Success response with scan status details.

Body

application/json

progress_dataobject

tagsobject

schemaVersionstring

idstring

issues_newnumber

issues_fixednumber

started_atinteger

Timestamp when the scan started

ended_atinteger

Timestamp when the scan ended

statestring

locinteger

nfilesinteger

uidstring

fixcostsnullable string

trustlevelsnullable string

labelsobject

impactsobject

rootcausesobject

riskscoreinteger

logsarray of object

licensesobject

sca_severitiesobject

sast_severitiesobject

Request

JavaScriptCurlPython

const response = await fetch('<baseURL>/api/scan/status/{scanId}', {
    method: 'GET',
    headers: {},
});
const data = await response.json();

Response

200400403404

{
  "progress_data": {
    "currentdir": "text",
    "current_analysis": "text",
    "current_weakness": "text"
  },
  "tags": {
    "project_name": "text",
    "starter": "text",
    "filename": "text",
    "policy_id": "text",
    "branch": "text",
    "commitId": "text",
    "committer": "text",
    "commitMessage": "text",
    "policy_title": "text"
  },
  "schemaVersion": "text",
  "id": "text",
  "issues_new": 0,
  "issues_fixed": 0,
  "state": "text",
  "uid": "text",
  "fixcosts": "text",
  "trustlevels": "text",
  "logs": [
    {
      "logType": "text",
      "message": "text",
      "create_date": "2024-11-21T06:47:53.912Z",
      "update_date": "2024-11-21T06:47:53.912Z"
    }
  ],
  "licenses": {},
  "sca_severities": {},
  "sast_severities": {}
}

Get scan issues

Retrieve issues related to a specific scan using its ID with optional filters.

POST<baseURL>/api/scanlog/issues

Query parameters

Body

application/json

filterobject

Uploaded file object

Response

200400403

Successful response with scan issues details.

Body

application/json

dataarray of object

paginationobject

Request

JavaScriptCurlPython

const response = await fetch('<baseURL>/api/scanlog/issues', {
    method: 'POST',
    headers: {
      "Content-Type": "application/json"
    },
    body: JSON.stringify({}),
});
const data = await response.json();

Response

200400403

{
  "data": [
    {
      "issue_state": {
        "status": {
          "value": "text",
          "description": "text"
        },
        "schemaVersion": "text",
        "id": "text",
        "project_name": "text",
        "rule_id": "text",
        "issue_id": "text",
        "weakness_id": "text",
        "scan_id": "text",
        "severity": "text",
        "fixcost": "text",
        "history": [
          {
            "type": "text",
            "scan_id": "text",
            "status": "text"
          }
        ],
        "relations": {
          "scanBranches": [
            {
              "branch_name": "text",
              "scans": [
                "text"
              ]
            }
          ]
        }
      },
      "kb_fields": {
        "impacts": [
          "text"
        ],
        "labels": [
          "text"
        ],
        "rootcauses": [
          "text"
        ],
        "standards": [
          "text"
        ],
        "references": [
          "text"
        ],
        "trustlevel": "text"
      },
      "flow_steps": [
        {
          "code_snippet": {
            "text": "text"
          },
          "document_name": "text",
          "document_path": "text",
          "project_name": "text",
          "step_type": "text",
          "step_text": "text",
          "document_extension": "text"
        }
      ],
      "lang": "text"
    }
  ],
  "pagination": {
    "page": 0,
    "page_size": 0,
    "total": 0
  }
}

Add a new organization

This endpoint is used to add a new organization to the application. It accepts the 'orgname' field in the body. If no organization with this name exists, a new organization is created immediately.

POST<baseURL>/api/organization/add

Body

application/json

orgname*string

The name of the organization to be added

Response

200400

Successful response

Body

application/json

resultobject

errorboolean

Example: false

Request

JavaScriptCurlPython

const response = await fetch('<baseURL>/api/organization/add', {
    method: 'POST',
    headers: {
      "Content-Type": "application/json"
    },
    body: JSON.stringify({
      "orgname": "text"
    }),
});
const data = await response.json();

Response

200400

{
  "result": {
    "message": "successful"
  },
  "error": false
}

List organizations

Retrieves a list of organizations accessible to the user. Use the 'search' parameter in the query string to filter organizations by name.

GET<baseURL>/api/organization/list

Query parameters

Response

200400

Successful response

Body

application/json

itemsstring

Request

JavaScriptCurlPython

const response = await fetch('<baseURL>/api/organization/list', {
    method: 'GET',
    headers: {},
});
const data = await response.json();

Response

200400

[
  "Organization1",
  "Organization2"
]

Add a new project

Creates a new 'upload' type project that is ready for analysis when triggered at the scan/start endpoint.

POST<baseURL>/api/project/add

Body

application/json

Description of the request body

project_name*string

The name of the project used in generation. Must be unique within the organization.

descriptionstring

A brief summary of the project's purpose.

tagsarray of string

Tags to categorize and group the projects being maintained.

Response

200400

Successful response

Body

application/json

resultobject

errorboolean

Example: false

Request

JavaScriptCurlPython

const response = await fetch('<baseURL>/api/project/add', {
    method: 'POST',
    headers: {
      "Content-Type": "application/json"
    },
    body: JSON.stringify({
      "project_name": "text"
    }),
});
const data = await response.json();

Response

200400

{
  "result": {
    "message": "successful"
  },
  "error": false
}

Start a new scan

Only upload type projects can be scanned. The related project should be created via the project/add endpoint before sending this request with the related value.

POST<baseURL>/api/scan/start

Body

application/x-www-form-urlencoded

upfile*string (binary)

Uploaded file object

project*string

Project under which the uploaded file will be analyzed

branchstring

Branch under which the uploaded file will be analyzed

policy_idstring

Scope under which the analysis should be processed

Response

200400403404

Scan started successfully

Body

application/json

errorboolean

messagestring

scan_idstring

Request

JavaScriptCurlPython

const response = await fetch('<baseURL>/api/scan/start', {
    method: 'POST',
    headers: {
      "Content-Type": "application/x-www-form-urlencoded"
    },
    body: JSON.stringify({
      "project": "text",
      "upfile": "binary"
    }),
});
const data = await response.json();

Response

200400403404

{
  "error": false,
  "message": "text",
  "scan_id": "text"
}

Stop an active scan

Stops an active scan immediately if the provided scan ID exists.

POST<baseURL>/api/scan/stop

Body

application/json

scan_id*string

The ID of the scan to be stopped

Response

200400403404

Scan stopped successfully

Body

application/json

resultobject

errorboolean

Example: false

Request

JavaScriptCurlPython

const response = await fetch('<baseURL>/api/scan/stop', {
    method: 'POST',
    headers: {
      "Content-Type": "application/json"
    },
    body: JSON.stringify({
      "scan_id": "text"
    }),
});
const data = await response.json();

Response

200400403404

{
  "result": {
    "message": "successfull"
  },
  "error": false
}

Retrieve all policies

Retrieves all policies created in the organization, including default bundled policies.

GET<baseURL>/api/policy/list

Query parameters

Response

200400403

List of policies

Body

application/json

idstring

Unique identifier of the policy

descriptionstring

Description of the policy

engine_settingsobject

fixcostobject

impactsobject

is_defaultboolean

Indicates if the policy is a default bundled policy

labelsobject

platformobject

policy_titlestring

Title of the policy

rootcausesobject

scan_typeobject

schemaVersionstring

Version of the schema

severitiesobject

standardsobject

trustlevelobject

Request

JavaScriptCurlPython

const response = await fetch('<baseURL>/api/policy/list', {
    method: 'GET',
    headers: {},
});
const data = await response.json();

Response

200400403

[
  {
    "id": "text",
    "description": "text",
    "engine_settings": {
      "enable_full_points_to_analysis": false,
      "decompiled_code_scan_module": false,
      "sast_module": false,
      "sca_module": false
    },
    "fixcost": {
      "include": [
        "text"
      ],
      "exclude": [
        "text"
      ]
    },
    "impacts": {
      "include": [
        "text"
      ],
      "exclude": [
        "text"
      ]
    },
    "is_default": false,
    "labels": {
      "include": [
        "text"
      ],
      "exclude": [
        "text"
      ]
    },
    "platform": {
      "include": [
        "text"
      ],
      "exclude": [
        "text"
      ]
    },
    "policy_title": "text",
    "rootcauses": {
      "include": [
        "text"
      ],
      "exclude": [
        "text"
      ]
    },
    "scan_type": {
      "include": [
        "text"
      ],
      "exclude": [
        "text"
      ]
    },
    "schemaVersion": "text",
    "severities": {
      "include": [
        "text"
      ],
      "exclude": [
        "text"
      ]
    },
    "standards": {
      "include": [
        "text"
      ],
      "exclude": [
        "text"
      ]
    },
    "trustlevel": {
      "include": [
        "text"
      ],
      "exclude": [
        "text"
      ]
    }
  }
]

Get selected policy

Retrieve policy by given payload

GET<baseURL>/api/policy/{policyId}

Path parameters

policyId*string

Filter policies by policy title

Response

200400403404

Policy which demanded

Body

application/json

idstring

Unique identifier of the policy

descriptionstring

Description of the policy

engine_settingsobject

fixcostobject

impactsobject

is_defaultboolean

Indicates if the policy is a default bundled policy

labelsobject

platformobject

policy_titlestring

Title of the policy

rootcausesobject

scan_typeobject

schemaVersionstring

Version of the schema

severitiesobject

standardsobject

trustlevelobject

Request

JavaScriptCurlPython

const response = await fetch('<baseURL>/api/policy/{policyId}', {
    method: 'GET',
    headers: {},
});
const data = await response.json();

Response

200400403404

{
  "id": "text",
  "description": "text",
  "engine_settings": {
    "enable_full_points_to_analysis": false,
    "decompiled_code_scan_module": false,
    "sast_module": false,
    "sca_module": false
  },
  "fixcost": {
    "include": [
      "text"
    ],
    "exclude": [
      "text"
    ]
  },
  "impacts": {
    "include": [
      "text"
    ],
    "exclude": [
      "text"
    ]
  },
  "is_default": false,
  "labels": {
    "include": [
      "text"
    ],
    "exclude": [
      "text"
    ]
  },
  "platform": {
    "include": [
      "text"
    ],
    "exclude": [
      "text"
    ]
  },
  "policy_title": "text",
  "rootcauses": {
    "include": [
      "text"
    ],
    "exclude": [
      "text"
    ]
  },
  "scan_type": {
    "include": [
      "text"
    ],
    "exclude": [
      "text"
    ]
  },
  "schemaVersion": "text",
  "severities": {
    "include": [
      "text"
    ],
    "exclude": [
      "text"
    ]
  },
  "standards": {
    "include": [
      "text"
    ],
    "exclude": [
      "text"
    ]
  },
  "trustlevel": {
    "include": [
      "text"
    ],
    "exclude": [
      "text"
    ]
  }
}

Create a git connected project

Create a git-connected project with given parameters.

POST<baseURL>/api/integration/git/set

Body

application/json

branchstring

Repository's default branch for standard analysis

gitobject

policy_id*string

Project's default policy for standard analysis

project_name*string

Unique project name within the organization

Example: "my-project"

tagsarray of string

Tags to categorize and group project

Response

200400403

Successful response

Body

application/json

errorboolean

Indicates if an error occurred

messagestring

Human-readable message about project creation status

scan_idnullable string

ID of the started scan (if scan started successfully)

Request

JavaScriptCurlPython

const response = await fetch('<baseURL>/api/integration/git/set', {
    method: 'POST',
    headers: {
      "Content-Type": "application/json"
    },
    body: JSON.stringify({
      "project_name": "my-project",
      "policy_id": "text"
    }),
});
const data = await response.json();

Response

200400403

{
  "error": false,
  "message": "text",
  "scan_id": "text"
}

Create a GitHub connected project

Create a GitHub-connected project with given parameters.

POST<baseURL>/api/integration/github/set

Body

application/json

repoId*string (${github.repository.name}:${github.repository.id})

GitHub repository id and name combined as string concatenated.

Example: "repo_name:1234id"

type*enum

Repositories view information (public or private)

publicprivate

account*string (${github.repository.owner.login})

Related repository owner's GitHub login

branch*string

Default branch of the project for standard analysis.

Example: "main"

policy_id*string

Project's default policy for standard analysis

tagsarray of string

Tags to categorize and group projects

Response

200400403

Successful response

Body

application/json

errorboolean

Indicates if an error occurred

messagestring

Human-readable message about project creation status

scan_idnullable string

ID of the started scan (if scan started successfully)

Request

JavaScriptCurlPython

const response = await fetch('<baseURL>/api/integration/github/set', {
    method: 'POST',
    headers: {
      "Content-Type": "application/json"
    },
    body: JSON.stringify({
      "repoId": "repo_name:1234id",
      "type": "public",
      "account": "text",
      "policy_id": "text",
      "branch": "main"
    }),
});
const data = await response.json();

Response

200400403

{
  "error": false,
  "message": "text",
  "scan_id": "text"
}

Create a GitLab connected project

Create a GitLab-connected project with given parameters.

POST<baseURL>/api/integration/gitlab/set

Body

application/json

repoId*string (${GitLab.repository.name}:${GitLab.repository.id})

GitLab repository id and name combined as string concatenated.

Example: "repo_name:1234id"

branch*string

Default branch of the project for standard analysis.

Example: "main"

type*enum

Repositories view information (public or private)

publicprivate

account*string (${gitlab.account.id})

Related repository owner's GitLab login

policy_id*string

Project's default policy for standard analysis

tagsarray of string

Tags to categorize and group projects

Response

200400403

Successful response

Body

application/json

errorboolean

Indicates if an error occurred

messagestring

Human-readable message about project creation status

scan_idnullable string

ID of the started scan (if scan started successfully)

Request

JavaScriptCurlPython

const response = await fetch('<baseURL>/api/integration/gitlab/set', {
    method: 'POST',
    headers: {
      "Content-Type": "application/json"
    },
    body: JSON.stringify({
      "repoId": "repo_name:1234id",
      "type": "public",
      "account": "text",
      "policy_id": "text",
      "branch": "main"
    }),
});
const data = await response.json();

Response

200400403

{
  "error": false,
  "message": "text",
  "scan_id": "text"
}

Create a Azure connected project

Create a Azure-connected project with given parameters.

POST<baseURL>/api/integration/azure/set

Body

application/json

repoId*string

Depends on repository type, if it is Git type repository it wil formatted like, ${azureRepository.name}:${azureRepository.,d}:${azureRepository.project.id} but if it is Tfvc project, it will formetted like: ${tfvcItem.name}:${azureRepository.id}.

Example: "repo_name:1234id:projId | item_name:item_id"

type*enum

Repositories source control type

TfsGitTfsVersionControlgittfs

branch*string

Default branch of the project for standard analysis.

Example: "main"

account*string (${azureAccount.accountName})

Related repository owner's Azure account

policy_id*string

Project's default policy for standard analysis

pathstring (${azureItem.path})

It will required only importing tfvc project.

tagsarray of string

Tags to categorize and group projects

Response

200400403

Successful response

Body

application/json

errorboolean

Indicates if an error occurred

messagestring

Human-readable message about project creation status

scan_idnullable string

ID of the started scan (if scan started successfully)

Request

JavaScriptCurlPython

const response = await fetch('<baseURL>/api/integration/azure/set', {
    method: 'POST',
    headers: {
      "Content-Type": "application/json"
    },
    body: JSON.stringify({
      "repoId": "repo_name:1234id:projId | item_name:item_id",
      "type": "TfsGit",
      "account": "text",
      "policy_id": "text",
      "branch": "main"
    }),
});
const data = await response.json();

Response

200400403

{
  "error": false,
  "message": "text",
  "scan_id": "text"
}

Create a Bitbucket connected project

Create a Bitbucket connected project with given parameters.

POST<baseURL>/api/integration/bitbucket/set

Query parameters

Body

application/json

repository*string

Bitbucket repository name.

Example: "my-repo"

type*enum

Repository view information.

Example: "public"

publicprivateBitbucket Server ProjectBitbucket Server User

projectName*string (${bitbucketRepository.name}_${bitbucketRepository.name})

Name for project generation in the application.

Example: "my-repo_my-repo"

projectKey*string

Used for connection URL generation.

Example: "PROJKEY"

account*string

Depends on environment; if Bitbucket server, use bitbucketProject.name. If cloud, use bitbucketWorkspace.account

Example: "my-project"

policy_id*string

Default policy ID for standard analysis.

Example: "7xoPVRFf6l86"

branch*string

Default branch of the project for standard analysis.

Example: "main"

workspacestring

Account's workspace information. Required if in a cloud environment.

Example: "my-workspace"

tagsarray of string

Tags to categorize and group projects.

Example: "[tag1, tag2]"

Response

200400

Successful response

Body

application/json

errorboolean

Indicates if there was an error.

messagestring

Detailed message about the project creation status.

scan_idnullable string

ID of the initiated scan, if applicable.

Request

JavaScriptCurlPython

const response = await fetch('<baseURL>/api/integration/bitbucket/set?server=false', {
    method: 'POST',
    headers: {
      "Content-Type": "application/json"
    },
    body: JSON.stringify({
      "repository": "my-repo",
      "type": "public",
      "projectName": "my-repo_my-repo",
      "projectKey": "PROJKEY",
      "account": "my-project",
      "policy_id": "7xoPVRFf6l86",
      "branch": "main"
    }),
});
const data = await response.json();

Response

200400

{
  "error": false,
  "message": "text",
  "scan_id": "text"
}

Trigger an existing Azure project scan

Trigger a scan for an existing Azure project with the provided parameters.

POST<baseURL>/api/integration/azure/start

Body

application/json

project*string

The project to be analyzed.

branchstring

Optional branch parameter for analyzing a different branch. Defaults to the project's default branch if not provided.

policy_idstring

Optional policy_id parameter for analyzing the project with a different policy scope. Defaults to the project's default policy_id if not provided.

Response

200400403

Successful response

Body

application/json

messagestring

Success message.

Example: "Scan started successfully."

scan_idstring

ID of the initiated scan.

Example: "scan1234"

Request

JavaScriptCurlPython

const response = await fetch('<baseURL>/api/integration/azure/start', {
    method: 'POST',
    headers: {
      "Content-Type": "application/json"
    },
    body: JSON.stringify({
      "project": "text"
    }),
});
const data = await response.json();

Response

200400403

{
  "message": "Scan started successfully.",
  "scan_id": "scan1234"
}

Trigger an existing Bitbucket project scan

Trigger a scan for an existing Bitbucket project with the provided parameters.

POST<baseURL>/api/integration/bitbucket/start

Body

application/json

project*string

The project to be analyzed.

branchstring

Optional branch parameter for analyzing a different branch. Defaults to the project's default branch if not provided.

policy_idstring

Optional policy_id parameter for analyzing the project with a different policy scope. Defaults to the project's default policy_id if not provided.

Response

200400403

Successful response

Body

application/json

messagestring

Success message.

Example: "Scan started successfully."

scan_idstring

ID of the initiated scan.

Example: "scan1234"

Request

JavaScriptCurlPython

const response = await fetch('<baseURL>/api/integration/bitbucket/start', {
    method: 'POST',
    headers: {
      "Content-Type": "application/json"
    },
    body: JSON.stringify({
      "project": "text"
    }),
});
const data = await response.json();

Response

200400403

{
  "message": "Scan started successfully.",
  "scan_id": "scan1234"
}

Trigger an existing Git project scan

Trigger a scan for an existing Git project with the provided parameters.

POST<baseURL>/api/integration/git/start

Body

application/json

project*string

The project to be analyzed.

branchstring

Optional branch parameter for analyzing a different branch. Defaults to the project's default branch if not provided.

policy_idstring

Optional policy_id parameter for analyzing the project with a different policy scope. Defaults to the project's default policy_id if not provided.

Response

200400403

Successful response

Body

application/json

messagestring

Success message.

Example: "Scan started successfully."

scan_idstring

ID of the initiated scan.

Example: "scan1234"

Request

JavaScriptCurlPython

const response = await fetch('<baseURL>/api/integration/git/start', {
    method: 'POST',
    headers: {
      "Content-Type": "application/json"
    },
    body: JSON.stringify({
      "project": "text"
    }),
});
const data = await response.json();

Response

200400403

{
  "message": "Scan started successfully.",
  "scan_id": "scan1234"
}

Trigger an existing Github project scan

Trigger a scan for an existing Github project with the provided parameters.

POST<baseURL>/api/integration/github/start

Body

application/json

project*string

The project to be analyzed.

branchstring

Optional branch parameter for analyzing a different branch. Defaults to the project's default branch if not provided.

policy_idstring

Optional policy_id parameter for analyzing the project with a different policy scope. Defaults to the project's default policy_id if not provided.

Response

200400403

Successful response

Body

application/json

messagestring

Success message.

Example: "Scan started successfully."

scan_idstring

ID of the initiated scan.

Example: "scan1234"

Request

JavaScriptCurlPython

const response = await fetch('<baseURL>/api/integration/github/start', {
    method: 'POST',
    headers: {
      "Content-Type": "application/json"
    },
    body: JSON.stringify({
      "project": "text"
    }),
});
const data = await response.json();

Response

200400403

{
  "message": "Scan started successfully.",
  "scan_id": "scan1234"
}

Trigger an existing Gitlab project scan

Trigger a scan for an existing Gitlab project with the provided parameters.

POST<baseURL>/api/integration/gitlab/start

Body

application/json

project_namestring

The project to be analyzed.

branchstring

Optional branch parameter for analyzing a different branch. Defaults to the project's default branch if not provided.

policy_idstring

Optional policy_id parameter for analyzing the project with a different policy scope. Defaults to the project's default policy_id if not provided.

Response

200400403

Successful response

Body

application/json

messagestring

Success message.

Example: "Scan started successfully."

scan_idstring

ID of the initiated scan.

Example: "scan1234"

Request

JavaScriptCurlPython

const response = await fetch('<baseURL>/api/integration/gitlab/start', {
    method: 'POST',
    headers: {
      "Content-Type": "application/json"
    },
    body: JSON.stringify({}),
});
const data = await response.json();

Response

200400403

{
  "message": "Scan started successfully.",
  "scan_id": "scan1234"
}