API Documentation

PreviousTerms of Service NextCT Server Installation

Last updated 7 months ago

Was this helpful?

List organizations

get

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

Query parameters

searchstringOptional

Filter organizations by name (alphanumeric, dash, underscore, and dot allowed).

Example: example_org

Responses

200

Successful response

application/json

Responsestring[]Example: ["Organization1","Organization2"]

400

Error response

application/json

get

GET /api/organization/list HTTP/1.1
Host: <baseURL>
Accept: */*

[
  "Organization1",
  "Organization2"
]

Retrieve all policies

get

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

Query parameters

searchstringOptional

Filter policies by policy title

Responses

200

List of policies

application/json

400

- Search text cannot contain symbols except alphanumeric, dash, underscore, and dot notations - Error occurred in policy list

application/json

403

Access denied

application/json

get

GET /api/policy/list HTTP/1.1
Host: <baseURL>
Accept: */*

[
  {
    "id": "text",
    "description": "text",
    "engine_settings": {
      "maximum_execution_time_in_minutes": 1,
      "maximum_method_call_depth": 1,
      "enable_full_points_to_analysis": true,
      "decompiled_code_scan_module": true,
      "sast_module": true,
      "sca_module": true
    },
    "fixcost": {
      "include": [
        "text"
      ],
      "exclude": [
        "text"
      ]
    },
    "impacts": {
      "include": [
        "text"
      ],
      "exclude": [
        "text"
      ]
    },
    "is_default": true,
    "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

get

Retrieve policy by given payload

Path parameters

policyIdstringRequired

Filter policies by policy title

Responses

200

Policy which demanded

application/json

400

Error response

application/json

403

Access denied

application/json

404

Policy not found

application/json

get

GET /api/policy/{policyId} HTTP/1.1
Host: <baseURL>
Accept: */*

{
  "id": "text",
  "description": "text",
  "engine_settings": {
    "maximum_execution_time_in_minutes": 1,
    "maximum_method_call_depth": 1,
    "enable_full_points_to_analysis": true,
    "decompiled_code_scan_module": true,
    "sast_module": true,
    "sca_module": true
  },
  "fixcost": {
    "include": [
      "text"
    ],
    "exclude": [
      "text"
    ]
  },
  "impacts": {
    "include": [
      "text"
    ],
    "exclude": [
      "text"
    ]
  },
  "is_default": true,
  "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"
    ]
  }
}

Add a new organization

post

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.

Body

orgnamestringRequired

The name of the organization to be added

Responses

200

Successful response

application/json

400

Error response

application/json

post

POST /api/organization/add HTTP/1.1
Host: <baseURL>
Content-Type: application/json
Accept: */*
Content-Length: 18

{
  "orgname": "text"
}

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

Add a new project

post

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

Body

project_namestring · min: 3 · max: 1000Required

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

descriptionstring · max: 5000Optional

A brief summary of the project's purpose.

tagsstring[] · max: 5Optional

Tags to categorize and group the projects being maintained.

Responses

200

Successful response

application/json

400

Error response

application/json

post

POST /api/project/add HTTP/1.1
Host: <baseURL>
Content-Type: application/json
Accept: */*
Content-Length: 60

{
  "project_name": "text",
  "description": "text",
  "tags": [
    "text"
  ]
}

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

Start a new scan

post

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.

Body

upfilestring · binaryRequired

Uploaded file object

projectstringRequired

Project under which the uploaded file will be analyzed

branchstringOptional

Branch under which the uploaded file will be analyzed

policy_idstringOptional

Scope under which the analysis should be processed

Responses

200

Scan started successfully

application/json

400

Bad Request

application/json

403

Forbidden

application/json

404

Not Found

application/json

post

POST /api/scan/start HTTP/1.1
Host: <baseURL>
Content-Type: application/x-www-form-urlencoded
Accept: */*
Content-Length: 71

"upfile='binary'&project='text'&branch='text'&policy_id='text'"

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

Stop an active scan

post

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

Body

scan_idstringRequired

The ID of the scan to be stopped

Responses

200

Scan stopped successfully

application/json

400

- Missing body parameter: - Error occurred while trying to stop scan

application/json

403

Access denied

application/json

404

Scan not found

application/json

post

POST /api/scan/stop HTTP/1.1
Host: <baseURL>
Content-Type: application/json
Accept: */*
Content-Length: 18

{
  "scan_id": "text"
}

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

Create a git connected project

post

Create a git-connected project with given parameters.

Body

branchstringOptional

Repository's default branch for standard analysis

policy_idstringRequired

Project's default policy for standard analysis

project_namestring · min: 3 · max: 1000Required

Unique project name within the organization

Example: my-project

tagsstring[] · max: 5Optional

Tags to categorize and group project

Responses

200

Successful response

application/json

400

Error response

application/json

403

Access denied

application/json

post

POST /api/integration/git/set HTTP/1.1
Host: <baseURL>
Content-Type: application/json
Accept: */*
Content-Length: 137

{
  "branch": "text",
  "git": {
    "password": "text",
    "url": "text",
    "username": "text"
  },
  "policy_id": "text",
  "project_name": "my-project",
  "tags": [
    "text"
  ]
}

{
  "error": false,
  "message": "Project created and scan started successfully.",
  "scan_id": "scanId"
}

Create a GitHub connected project

post

Create a GitHub-connected project with given parameters.

Body

repoIdstring · ${github.repository.name}:${github.repository.id}Required

GitHub repository id and name combined as string concatenated.

Example: repo_name:1234id

typestring · enumRequired

Repositories view information (public or private)

Possible values:

accountstring · ${github.repository.owner.login}Required

Related repository owner's GitHub login

branchstringRequired

Default branch of the project for standard analysis.

Example: main

policy_idstringRequired

Project's default policy for standard analysis

tagsstring[]Optional

Tags to categorize and group projects

Responses

200

Successful response

application/json

400

Error response

application/json

403

Access denied

application/json

post

POST /api/integration/github/set HTTP/1.1
Host: <baseURL>
Content-Type: application/json
Accept: */*
Content-Length: 113

{
  "repoId": "repo_name:1234id",
  "type": "public",
  "account": "text",
  "branch": "main",
  "policy_id": "text",
  "tags": [
    "text"
  ]
}

{
  "error": false,
  "message": "Project created but scan not started due to exceed weekly scan limitations.",
  "scan_id": null
}

Create a GitLab connected project

post

Create a GitLab-connected project with given parameters.

Body

repoIdstring · ${GitLab.repository.name}:${GitLab.repository.id}Required

GitLab repository id and name combined as string concatenated.

Example: repo_name:1234id

branchstringRequired

Default branch of the project for standard analysis.

Example: main

typestring · enumRequired

Repositories view information (public or private)

Possible values:

accountstring · ${gitlab.account.id}Required

Related repository owner's GitLab login

policy_idstringRequired

Project's default policy for standard analysis

tagsstring[]Optional

Tags to categorize and group projects

Responses

200

Successful response

application/json

400

Error response

application/json

403

Access denied

application/json

post

POST /api/integration/gitlab/set HTTP/1.1
Host: <baseURL>
Content-Type: application/json
Accept: */*
Content-Length: 113

{
  "repoId": "repo_name:1234id",
  "branch": "main",
  "type": "public",
  "account": "text",
  "policy_id": "text",
  "tags": [
    "text"
  ]
}

{
  "error": false,
  "message": "Project created but scan not started due to exceed weekly scan limitations.",
  "scan_id": null
}

Create a Azure connected project

post

Create a Azure-connected project with given parameters.

Body

repoIdstringRequired

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

typestring · enumRequired

Repositories source control type

Possible values:

branchstringRequired

Default branch of the project for standard analysis.

Example: main

accountstring · ${azureAccount.accountName}Required

Related repository owner's Azure account

policy_idstringRequired

Project's default policy for standard analysis

pathstring · ${azureItem.path}Optional

It will required only importing tfvc project.

tagsstring[]Optional

Tags to categorize and group projects

Responses

200

Successful response

application/json

400

Error response

application/json

403

Access denied

application/json

post

POST /api/integration/azure/set HTTP/1.1
Host: <baseURL>
Content-Type: application/json
Accept: */*
Content-Length: 154

{
  "repoId": "repo_name:1234id:projId | item_name:item_id",
  "type": "TfsGit",
  "branch": "main",
  "account": "text",
  "policy_id": "text",
  "path": "text",
  "tags": [
    "text"
  ]
}

{
  "error": false,
  "message": "Project created but scan not started due to exceed weekly scan limitations.",
  "scan_id": null
}

Create a Bitbucket connected project

post

Create a Bitbucket connected project with given parameters.

Query parameters

serverbooleanRequired

If the connection is coming from a Bitbucket server, this should be true. If cloud, it should be false.

Body

repositorystringRequired

Bitbucket repository name.

Example: my-repo

typestring · enumRequired

Repository view information.

Example: publicPossible values:

projectNamestring · ${bitbucketRepository.name}_${bitbucketRepository.name}Required

Name for project generation in the application.

Example: my-repo_my-repo

projectKeystringRequired

Used for connection URL generation.

Example: PROJKEY

accountstringRequired

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

Example: my-project

policy_idstringRequired

Default policy ID for standard analysis.

Example: 7xoPVRFf6l86

branchstringRequired

Default branch of the project for standard analysis.

Example: main

workspacestringOptional

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

Example: my-workspace

tagsstring[]Optional

Tags to categorize and group projects.

Example: [tag1, tag2]

Responses

200

Successful response

application/json

400

Error response

application/json

post

POST /api/integration/bitbucket/set?server=true HTTP/1.1
Host: <baseURL>
Content-Type: application/json
Accept: */*
Content-Length: 210

{
  "repository": "my-repo",
  "type": "public",
  "projectName": "my-repo_my-repo",
  "projectKey": "PROJKEY",
  "account": "my-project",
  "policy_id": "7xoPVRFf6l86",
  "branch": "main",
  "workspace": "my-workspace",
  "tags": "[tag1, tag2]"
}

{
  "error": false,
  "message": "Project created but scan not started due to exceeding weekly scan limitations.",
  "scan_id": null
}

Trigger an existing Azure project scan

post

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

Body

projectstringRequired

The project to be analyzed.

branchstringOptional

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

policy_idstringOptional

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

Responses

200

Successful response

application/json

400

Error response

application/json

403

Access denied

application/json

post

POST /api/integration/azure/start HTTP/1.1
Host: <baseURL>
Content-Type: application/json
Accept: */*
Content-Length: 53

{
  "project": "text",
  "branch": "text",
  "policy_id": "text"
}

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

Trigger an existing Bitbucket project scan

post

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

Body

projectstringRequired

The project to be analyzed.

branchstringOptional

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

policy_idstringOptional

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

Responses

200

Successful response

application/json

400

Error response

application/json

403

Access denied

application/json

post

POST /api/integration/bitbucket/start HTTP/1.1
Host: <baseURL>
Content-Type: application/json
Accept: */*
Content-Length: 53

{
  "project": "text",
  "branch": "text",
  "policy_id": "text"
}

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

Trigger an existing Git project scan

post

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

Body

projectstringRequired

The project to be analyzed.

branchstringOptional

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

policy_idstringOptional

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

Responses

200

Successful response

application/json

400

Error response

application/json

403

Access denied

application/json

post

POST /api/integration/git/start HTTP/1.1
Host: <baseURL>
Content-Type: application/json
Accept: */*
Content-Length: 53

{
  "project": "text",
  "branch": "text",
  "policy_id": "text"
}

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

Trigger an existing Github project scan

post

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

Body

projectstringRequired

The project to be analyzed.

branchstringOptional

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

policy_idstringOptional

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

Responses

200

Successful response

application/json

400

Error response

application/json

403

Access denied

application/json

post

POST /api/integration/github/start HTTP/1.1
Host: <baseURL>
Content-Type: application/json
Accept: */*
Content-Length: 53

{
  "project": "text",
  "branch": "text",
  "policy_id": "text"
}

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

Trigger an existing Gitlab project scan

post

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

Body

project_namestringOptional

The project to be analyzed.

branchstringOptional

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

policy_idstringOptional

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

Responses

200

Successful response

application/json

400

Error response

application/json

403

Access denied

application/json

post

POST /api/integration/gitlab/start HTTP/1.1
Host: <baseURL>
Content-Type: application/json
Accept: */*
Content-Length: 58

{
  "project_name": "text",
  "branch": "text",
  "policy_id": "text"
}

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

{
  "settings": {
    "analyse_settings": {
      "excluded_paths": "text",
      "sca": true,
      "sast": true,
      "license_detection": true,
      "default_policy": "text"
    },
    "monitoring_settings": {
      "post_scan_comment_sast_result": true,
      "create_pr_sca_new_issues": true,
      "create_pr_sca_backlog_issues": true,
      "assign_pr_sca": true,
      "assign_pr_sca_users": [
        "text"
      ],
      "push_event": true,
      "pull_request_event": true,
      "default_branch": "text",
      "webhook": {
        "active": true,
        "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": "2025-05-21T04:05:28.439Z",
  "tags": [
    "text"
  ],
  "total_loc": 1,
  "total_files": 1,
  "type": "text",
  "owner": "text",
  "team": [
    "text"
  ],
  "created_by": "text",
  "scan_ids": [
    "text"
  ],
  "isActive": true,
  "analytics": {
    "compliances": {
      "ANY_ADDITIONAL_PROPERTY": 1
    },
    "issueTrend": [
      {
        "id": "text",
        "date": "2025-05-21T04:05:28.439Z",
        "issues": {
          "open": 1,
          "closed": 1
        }
      }
    ],
    "topIssueCategories": {
      "ANY_ADDITIONAL_PROPERTY": 1
    },
    "_id": "text"
  },
  "state": "text",
  "last_scan_time": 1,
  "is_repository_accessible": true,
  "sast_severities_count": {
    "medium": 1,
    "critical": 1,
    "high": 1,
    "low": 1
  },
  "sca_issues_count": {
    "medium": 1,
    "critical": 1,
    "high": 1,
    "low": 1
  },
  "licenses_count": {
    "medium": 1,
    "critical": 1,
    "high": 1,
    "low": 1
  },
  "default_branch": "text",
  "branches": [
    {
      "branch_name": "text",
      "scans": [
        "text"
      ]
    }
  ]
}

[
  {
    "settings": {
      "analyse_settings": {
        "excluded_paths": "text",
        "sca": true,
        "sast": true,
        "license_detection": true,
        "default_policy": "text"
      },
      "monitoring_settings": {
        "post_scan_comment_sast_result": true,
        "create_pr_sca_new_issues": true,
        "create_pr_sca_backlog_issues": true,
        "assign_pr_sca": true,
        "assign_pr_sca_users": [
          "text"
        ],
        "push_event": true,
        "pull_request_event": true,
        "default_branch": "text",
        "webhook": {
          "active": true,
          "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": "2025-05-21T04:05:28.439Z",
    "tags": [
      "text"
    ],
    "total_loc": 1,
    "total_files": 1,
    "type": "text",
    "owner": "text",
    "team": [
      "text"
    ],
    "created_by": "text",
    "scan_ids": [
      "text"
    ],
    "isActive": true,
    "analytics": {
      "compliances": {
        "ANY_ADDITIONAL_PROPERTY": 1
      },
      "issueTrend": [
        {
          "id": "text",
          "date": "2025-05-21T04:05:28.439Z",
          "issues": {
            "open": 1,
            "closed": 1
          }
        }
      ],
      "topIssueCategories": {
        "ANY_ADDITIONAL_PROPERTY": 1
      },
      "_id": "text"
    },
    "state": "text",
    "last_scan_time": 1,
    "last_scan_id": "text",
    "is_repository_accessible": true,
    "sast_issues_count": 1,
    "sca_issues_count": 1,
    "licenses_count": 1,
    "default_branch": "text"
  }
]

{
  "progress_data": {
    "progress": 1,
    "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": 1,
  "issues_fixed": 1,
  "started_at": 1,
  "ended_at": 1,
  "state": "text",
  "loc": 1,
  "nfiles": 1,
  "uid": "text",
  "fixcosts": "text",
  "trustlevels": "text",
  "labels": {
    "ANY_ADDITIONAL_PROPERTY": 1
  },
  "impacts": {
    "ANY_ADDITIONAL_PROPERTY": 1
  },
  "rootcauses": {
    "ANY_ADDITIONAL_PROPERTY": 1
  },
  "riskscore": 1,
  "logs": [
    {
      "logType": "text",
      "message": "text",
      "create_date": "2025-05-21T04:05:28.439Z",
      "update_date": "2025-05-21T04:05:28.439Z"
    }
  ],
  "licenses": {
    "low": 1,
    "high": 1,
    "unknown": 1
  },
  "sca_severities": {
    "high": 1,
    "critical": 1,
    "medium": 1
  },
  "sast_severities": {
    "critical": 1,
    "high": 1,
    "medium": 1,
    "low": 1
  }
}

Get scan issues

post

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

Query parameters

pagestringOptional

Page ID for pagination (default: 50)

pageSizestring · max: 500Optional

Page size for pagination

Body

Responses

200

Successful response with scan issues details.

application/json

400

- Page size max limit cannot be more than 500. - Filter search cannot contain symbols except alphanumeric, dash, underscore, and dot notations.

application/json

403

Access denied

application/json

post

POST /api/scanlog/issues HTTP/1.1
Host: <baseURL>
Content-Type: application/json
Accept: */*
Content-Length: 193

{
  "filter": {
    "status": [
      "Open"
    ],
    "projectName": "text",
    "assignee": [
      "text"
    ],
    "severities": [
      "critical"
    ],
    "state": [
      "Recurrent"
    ],
    "issue_id": "text",
    "scan_id": "text",
    "platforms": [
      "csharp"
    ],
    "branch": "text"
  }
}

{
  "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",
        "ticket": {},
        "tags": {},
        "severity": "text",
        "fixcost": "text",
        "history": [
          {
            "type": "text",
            "scan_id": "text",
            "status": "text",
            "date": 1
          }
        ],
        "relations": {
          "scanBranches": [
            {
              "branch_name": "text",
              "scans": [
                "text"
              ]
            }
          ]
        }
      },
      "kb_fields": {
        "impacts": [
          "text"
        ],
        "labels": [
          "text"
        ],
        "rootcauses": [
          "text"
        ],
        "standards": [
          "text"
        ],
        "references": [
          "text"
        ],
        "platformnotes": {
          "ANY_ADDITIONAL_PROPERTY": {
            "description": "text",
            "mitigation": "text"
          }
        },
        "summary": {
          "ANY_ADDITIONAL_PROPERTY": "text"
        },
        "title": {
          "ANY_ADDITIONAL_PROPERTY": "text"
        },
        "trustlevel": "text"
      },
      "flow_steps": [
        {
          "code_snippet": {
            "text": "text",
            "start_line": 1,
            "end_line": 1
          },
          "document_name": "text",
          "document_path": "text",
          "project_name": "text",
          "start_linenumber": 1,
          "end_linenumber": 1,
          "start_codespan": 1,
          "end_codespan": 1,
          "step_type": "text",
          "step_text": "text",
          "document_extension": "text"
        }
      ],
      "lang": "text"
    }
  ],
  "pagination": {
    "page": 1,
    "page_size": 1,
    "total": 1
  }
}

API Documentation

API Documentation

List organizations

Retrieve all policies

Get selected policy

Add a new organization

Add a new project

Start a new scan

Stop an active scan

Create a git connected project

Create a GitHub connected project

Create a GitLab connected project

Create a Azure connected project

Create a Bitbucket connected project

Trigger an existing Azure project scan

Trigger an existing Bitbucket project scan

Trigger an existing Git project scan

Trigger an existing Github project scan

Trigger an existing Gitlab project scan

Retrieve project details

List projects

Get scan status

Get scan issues