API Documentation
Last updated
Was this helpful?
Last updated
Was this helpful?
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.
/organization/add
The name of the organization to be added
Retrieves a list of organizations accessible to the user. Use the 'search' parameter in the query string to filter organizations by name.
/organization/list
Filter organizations by name (alphanumeric, dash, underscore, and dot allowed).
example_org
Creates a new 'upload' type project that is ready for analysis when triggered at the scan/start endpoint.
/project/add
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.
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.
/scan/start
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
Stops an active scan immediately if the provided scan ID exists.
/scan/stop
The ID of the scan to be stopped
Retrieves all policies created in the organization, including default bundled policies.
/policy/list
Filter policies by policy title
Retrieve policy by given payload
/policy/{policyId}
Filter policies by policy title
Create a git-connected project with given parameters.
/integration/git/set
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
Create a GitHub-connected project with given parameters.
/integration/github/set
Project's default policy for standard analysis
GitHub repository id and name combined as string concatenated.
repo_name:1234id
Related repository owner's GitHub login
Default branch of the project for standard analysis.
main
Repositories view information (public or private)
public
, private
Tags to categorize and group projects
Create a GitLab-connected project with given parameters.
/integration/gitlab/set
Project's default policy for standard analysis
Default branch of the project for standard analysis.
main
GitLab repository id and name combined as string concatenated.
repo_name:1234id
Related repository owner's GitLab login
Repositories view information (public or private)
public
, private
Tags to categorize and group projects
Create a Azure-connected project with given parameters.
/integration/azure/set
Project's default policy for standard analysis
Default branch of the project for standard analysis.
main
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
Related repository owner's Azure account
It will required only importing tfvc project.
Repositories source control type
TfsGit
, TfsVersionControl
, git
, tfs
Tags to categorize and group projects
Create a Bitbucket connected project with given parameters.
/integration/bitbucket/set
If the connection is coming from a Bitbucket server, this should be true. If cloud, it should be false.
Default branch of the project for standard analysis.
main
Bitbucket repository name.
my-repo
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
Account's workspace information. Required if in a cloud environment.
my-workspace
Repository view information.
public
public
, private
, Bitbucket Server Project
, Bitbucket Server User
Tags to categorize and group projects.
[tag1, tag2]
Trigger a scan for an existing Azure project with the provided parameters.
/integration/azure/start
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.