API Documentation
Last updated
Last updated
Retrieves a list of organizations accessible to the user. Use the 'search' parameter in the query string to filter organizations by name.
Successful response
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.
The name of the organization to be added
Successful response
false
Stops an active scan immediately if the provided scan ID exists.
The ID of the scan to be stopped
Scan stopped successfully
false
Creates a new 'upload' type project that is ready for analysis when triggered at the scan/start endpoint.
Description of the request body
The name of the project used in generation. Must be unique within the organization.
A brief summary of the project's purpose.
Tags to categorize and group the projects being maintained.
Successful response
false
Trigger a scan for an existing Azure project with the provided parameters.
The project to be analyzed.
Optional branch parameter for analyzing a different branch. Defaults to the project's default branch if not provided.
Optional policy_id parameter for analyzing the project with a different policy scope. Defaults to the project's default policy_id if not provided.
Successful response
Success message.
"Scan started successfully."
ID of the initiated scan.
"scan1234"
Trigger a scan for an existing Bitbucket project with the provided parameters.
The project to be analyzed.
Optional branch parameter for analyzing a different branch. Defaults to the project's default branch if not provided.
Optional policy_id parameter for analyzing the project with a different policy scope. Defaults to the project's default policy_id if not provided.
Successful response
Success message.
"Scan started successfully."
ID of the initiated scan.
"scan1234"
Trigger a scan for an existing Git project with the provided parameters.
The project to be analyzed.
Optional branch parameter for analyzing a different branch. Defaults to the project's default branch if not provided.
Optional policy_id parameter for analyzing the project with a different policy scope. Defaults to the project's default policy_id if not provided.
Successful response
Success message.
"Scan started successfully."
ID of the initiated scan.
"scan1234"
Trigger a scan for an existing Github project with the provided parameters.
The project to be analyzed.
Optional branch parameter for analyzing a different branch. Defaults to the project's default branch if not provided.
Optional policy_id parameter for analyzing the project with a different policy scope. Defaults to the project's default policy_id if not provided.
Successful response
Success message.
"Scan started successfully."
ID of the initiated scan.
"scan1234"
Trigger a scan for an existing Gitlab project with the provided parameters.
The project to be analyzed.
Optional branch parameter for analyzing a different branch. Defaults to the project's default branch if not provided.
Optional policy_id parameter for analyzing the project with a different policy scope. Defaults to the project's default policy_id if not provided.
Successful response
Success message.
"Scan started successfully."
ID of the initiated scan.
"scan1234"
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.
Uploaded file object
Project under which the uploaded file will be analyzed
Branch under which the uploaded file will be analyzed
Scope under which the analysis should be processed
Scan started successfully
Create a GitHub-connected project with given parameters.
GitHub repository id and name combined as string concatenated.
"repo_name:1234id"
Repositories view information (public or private)
Related repository owner's GitHub login
Default branch of the project for standard analysis.
"main"
Project's default policy for standard analysis
Tags to categorize and group projects
Successful response
Indicates if an error occurred
Human-readable message about project creation status
ID of the started scan (if scan started successfully)
Create a GitLab-connected project with given parameters.
GitLab repository id and name combined as string concatenated.
"repo_name:1234id"
Default branch of the project for standard analysis.
"main"
Repositories view information (public or private)
Related repository owner's GitLab login
Project's default policy for standard analysis
Tags to categorize and group projects
Successful response
Indicates if an error occurred
Human-readable message about project creation status
ID of the started scan (if scan started successfully)
Create a Azure-connected project with given parameters.
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}
.
"repo_name:1234id:projId | item_name:item_id"
Repositories source control type
Default branch of the project for standard analysis.
"main"
Related repository owner's Azure account
Project's default policy for standard analysis
It will required only importing tfvc project.
Tags to categorize and group projects
Successful response
Indicates if an error occurred
Human-readable message about project creation status
ID of the started scan (if scan started successfully)
Retrieve issues related to a specific scan using its ID with optional filters.
Successful response with scan issues details.
Retrieve the status and details of a scan using its ID.
URL path to provide the scan ID.
Success response with scan status details.
Timestamp when the scan started
Timestamp when the scan ended
Create a Bitbucket connected project with given parameters.
Bitbucket repository name.
"my-repo"
Repository view information.
"public"
Name for project generation in the application.
"my-repo_my-repo"
Used for connection URL generation.
"PROJKEY"
Depends on environment; if Bitbucket server, use bitbucketProject.name
. If cloud, use bitbucketWorkspace.account
"my-project"
Default policy ID for standard analysis.
"7xoPVRFf6l86"
Default branch of the project for standard analysis.
"main"
Account's workspace information. Required if in a cloud environment.
"my-workspace"
Tags to categorize and group projects.
"[tag1, tag2]"
Successful response
Indicates if there was an error.
Detailed message about the project creation status.
ID of the initiated scan, if applicable.
Retrieves all policies created in the organization, including default bundled policies.
List of policies
Unique identifier of the policy
Description of the policy
Indicates if the policy is a default bundled policy
Title of the policy
Version of the schema
Create a git-connected project with given parameters.
Repository's default branch for standard analysis
Project's default policy for standard analysis
Unique project name within the organization
"my-project"
Tags to categorize and group project
Successful response
Indicates if an error occurred
Human-readable message about project creation status
ID of the started scan (if scan started successfully)
Retrieve policy by given payload
Filter policies by policy title
Policy which demanded
Unique identifier of the policy
Description of the policy
Indicates if the policy is a default bundled policy
Title of the policy
Version of the schema
Retrieves detailed information about a specific project, including branch scan statistics and values.
Successful response
Retrieves a list of projects based on the provided parameters.
Successful response