API Documentation | CodeThreat

CodeThreat - Knowledge Center

CodeThreat Github

Retrieve project details

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

get

/project

Query parameters

branchstring

Retrieve project-related branch scan statistics and values. Must provide a valid branch name.

Example: main

keystringrequired

Project name to retrieve the specific project details. Must provide a valid project name.

Example: example_project

Responses

application/json

cURL

JavaScript

Python

HTTP

curl -L \
  --url '<baseURL>/api/project?key=text'

200

400

{
  "schemaVersion": "text",
  "project_name": "text",
  "description": "text",
  "version": "text",
  "created_at": "2025-02-22T08:11:16.493Z",
  "total_loc": 1,
  "total_files": 1,
  "type": "text",
  "owner": "text",
  "created_by": "text",
  "isActive": true,
  "state": "text",
  "last_scan_time": 1,
  "is_repository_accessible": true,
  "default_branch": "text",
  "languages": [
    "text"
  ],
  "tags": [
    "text"
  ],
  "team": [
    "text"
  ],
  "scan_ids": [
    "text"
  ],
  "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
  },
  "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"
    }
  },
  "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,
      "push_event": true,
      "pull_request_event": true,
      "default_branch": "text",
      "assign_pr_sca_users": [
        "text"
      ],
      "webhook": {
        "active": true,
        "id": "text",
        "parameter": "text"
      }
    }
  },
  "analytics": {
    "_id": "text",
    "compliances": {
      "ANY_ADDITIONAL_PROPERTY": 1
    },
    "topIssueCategories": {
      "ANY_ADDITIONAL_PROPERTY": 1
    },
    "issueTrend": [
      {
        "id": "text",
        "date": "2025-02-22T08:11:16.493Z",
        "issues": {
          "open": 1,
          "closed": 1
        }
      }
    ]
  }
}

Successful response

List projects

Retrieves a list of projects based on the provided parameters.

get

/projects

Query parameters

pidstring

Page ID for pagination.

Example: 1

pagestring

Page number for pagination.

Example: 1

pageSizestring · max: 500

Number of projects per page, with a maximum limit of 500.

Example: 50

searchstring

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

Example: example_project

sortstring · enum

Criteria to sort projects: by name, size (descending/ascending), or scan date (newest first).

Example: name

Options: name, size_desc, size_asc, scan_date

qstring

Base64 encoded filter criteria for projects:

type: upload, git, github, gitlab, azure, bitbucket, jenkins
owner: Owner's username
languages: ["java", "javascript", "csharp", ...]
state: failure, run, stop, end

Example: base64_encoded_string

Responses

application/json

cURL

JavaScript

Python

HTTP

curl -L \
  --url '<baseURL>/api/projects'

200

400

[
  {
    "schemaVersion": "text",
    "project_name": "text",
    "description": "text",
    "version": "text",
    "created_at": "2025-02-22T08:11:16.493Z",
    "total_loc": 1,
    "total_files": 1,
    "type": "text",
    "owner": "text",
    "created_by": "text",
    "isActive": true,
    "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",
    "languages": [
      "text"
    ],
    "tags": [
      "text"
    ],
    "team": [
      "text"
    ],
    "scan_ids": [
      "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"
      }
    },
    "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,
        "push_event": true,
        "pull_request_event": true,
        "default_branch": "text",
        "assign_pr_sca_users": [
          "text"
        ],
        "webhook": {
          "active": true,
          "id": "text",
          "parameter": "text"
        }
      }
    },
    "analytics": {
      "_id": "text",
      "compliances": {
        "ANY_ADDITIONAL_PROPERTY": 1
      },
      "topIssueCategories": {
        "ANY_ADDITIONAL_PROPERTY": 1
      },
      "issueTrend": [
        {
          "id": "text",
          "date": "2025-02-22T08:11:16.493Z",
          "issues": {
            "open": 1,
            "closed": 1
          }
        }
      ]
    }
  }
]

Successful response

Get scan status

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

get

/scan/status/{scanId}

Path parameters

scanIdstringrequired

URL path to provide the scan ID.

Responses

application/json

cURL

JavaScript

Python

HTTP

curl -L \
  --url '<baseURL>/api/scan/status/{scanId}'

200

400

403

404

{
  "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",
  "riskscore": 1,
  "labels": {
    "ANY_ADDITIONAL_PROPERTY": 1
  },
  "impacts": {
    "ANY_ADDITIONAL_PROPERTY": 1
  },
  "rootcauses": {
    "ANY_ADDITIONAL_PROPERTY": 1
  },
  "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"
  },
  "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
  },
  "logs": [
    {
      "logType": "text",
      "message": "text",
      "create_date": "2025-02-22T08:11:16.493Z",
      "update_date": "2025-02-22T08:11:16.493Z"
    }
  ]
}

Success response with scan status details.

Get scan issues

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

post

/scanlog/issues

Query parameters

pagestring

Page ID for pagination (default: 50)

pageSizestring · max: 500

Page size for pagination

Body

filterobject

Uploaded file object

Responses

application/json

cURL

JavaScript

Python

HTTP

curl -L \
  --request POST \
  --url '<baseURL>/api/scanlog/issues' \
  --header 'Content-Type: application/json' \
  --data '{"filter":{"assignee":[null],"status":["Open"],"severities":["critical"],"state":["Recurrent"],"platforms":["csharp"]}}'

200

400

403

{
  "pagination": {
    "page": 1,
    "page_size": 1,
    "total": 1
  },
  "data": [
    {
      "lang": "text",
      "kb_fields": {
        "trustlevel": "text",
        "impacts": [
          "text"
        ],
        "labels": [
          "text"
        ],
        "rootcauses": [
          "text"
        ],
        "standards": [
          "text"
        ],
        "references": [
          "text"
        ],
        "summary": {
          "ANY_ADDITIONAL_PROPERTY": "text"
        },
        "title": {
          "ANY_ADDITIONAL_PROPERTY": "text"
        },
        "platformnotes": {
          "ANY_ADDITIONAL_PROPERTY": {
            "description": "text",
            "mitigation": "text"
          }
        }
      },
      "flow_steps": [
        {
          "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",
          "code_snippet": {
            "text": "text",
            "start_line": 1,
            "end_line": 1
          }
        }
      ],
      "issue_state": {
        "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",
        "status": {
          "value": "text",
          "description": "text"
        },
        "history": [
          {
            "type": "text",
            "scan_id": "text",
            "status": "text",
            "date": 1
          }
        ],
        "relations": {
          "scanBranches": [
            {
              "branch_name": "text",
              "scans": [
                "text"
              ]
            }
          ]
        }
      }
    }
  ]
}

Successful response with scan issues details.

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

/organization/add

Body

orgnamestringrequired

The name of the organization to be added

Responses

application/json

cURL

JavaScript

Python

HTTP

curl -L \
  --request POST \
  --url '<baseURL>/api/organization/add' \
  --header 'Content-Type: application/json' \
  --data '{"orgname":"text"}'

200

400

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

Successful response

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

/organization/list

Query parameters

searchstring

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

Example: example_org

Responses

application/json

cURL

JavaScript

Python

HTTP

curl -L \
  --url '<baseURL>/api/organization/list'

200

400

[
  "Organization1",
  "Organization2"
]

Successful response

Add a new project

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

post

/project/add

Body

project_namestring · min: 3 · max: 1000required

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

descriptionstring · max: 5000

A brief summary of the project's purpose.

tagsstring[]

Tags to categorize and group the projects being maintained.

Responses

application/json

cURL

JavaScript

Python

HTTP

curl -L \
  --request POST \
  --url '<baseURL>/api/project/add' \
  --header 'Content-Type: application/json' \
  --data '{"project_name":"text","tags":[null]}'

200

400

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

Successful response

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

/scan/start

Body

upfilestring · binaryrequired

Uploaded file object

projectstringrequired

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

Responses

application/json

cURL

JavaScript

Python

HTTP

curl -L \
  --request POST \
  --url '<baseURL>/api/scan/start' \
  --header 'Content-Type: application/x-www-form-urlencoded' \
  --data '{"upfile":"text","project":"text"}'

200

400

403

404

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

Scan started successfully

Stop an active scan

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

post

/scan/stop

Body

scan_idstringrequired

The ID of the scan to be stopped

Responses

application/json

cURL

JavaScript

Python

HTTP

curl -L \
  --request POST \
  --url '<baseURL>/api/scan/stop' \
  --header 'Content-Type: application/json' \
  --data '{"scan_id":"text"}'

200

400

403

404

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

Scan stopped successfully

Retrieve all policies

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

get

/policy/list

Query parameters

searchstring

Filter policies by policy title

Responses

application/json

cURL

JavaScript

Python

HTTP

curl -L \
  --url '<baseURL>/api/policy/list'

200

400

403

[
  {
    "id": "text",
    "description": "text",
    "is_default": true,
    "policy_title": "text",
    "schemaVersion": "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"
      ]
    },
    "labels": {
      "include": [
        "text"
      ],
      "exclude": [
        "text"
      ]
    },
    "platform": {
      "include": [
        "text"
      ],
      "exclude": [
        "text"
      ]
    },
    "rootcauses": {
      "include": [
        "text"
      ],
      "exclude": [
        "text"
      ]
    },
    "scan_type": {
      "include": [
        "text"
      ],
      "exclude": [
        "text"
      ]
    },
    "severities": {
      "include": [
        "text"
      ],
      "exclude": [
        "text"
      ]
    },
    "standards": {
      "include": [
        "text"
      ],
      "exclude": [
        "text"
      ]
    },
    "trustlevel": {
      "include": [
        "text"
      ],
      "exclude": [
        "text"
      ]
    }
  }
]

List of policies

Get selected policy

Retrieve policy by given payload

get

/policy/{policyId}

Path parameters

policyIdstringrequired

Filter policies by policy title

Responses

application/json

cURL

JavaScript

Python

HTTP

curl -L \
  --url '<baseURL>/api/policy/{policyId}'

200

400

403

404

{
  "id": "text",
  "description": "text",
  "is_default": true,
  "policy_title": "text",
  "schemaVersion": "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"
    ]
  },
  "labels": {
    "include": [
      "text"
    ],
    "exclude": [
      "text"
    ]
  },
  "platform": {
    "include": [
      "text"
    ],
    "exclude": [
      "text"
    ]
  },
  "rootcauses": {
    "include": [
      "text"
    ],
    "exclude": [
      "text"
    ]
  },
  "scan_type": {
    "include": [
      "text"
    ],
    "exclude": [
      "text"
    ]
  },
  "severities": {
    "include": [
      "text"
    ],
    "exclude": [
      "text"
    ]
  },
  "standards": {
    "include": [
      "text"
    ],
    "exclude": [
      "text"
    ]
  },
  "trustlevel": {
    "include": [
      "text"
    ],
    "exclude": [
      "text"
    ]
  }
}

Policy which demanded

Create a git connected project

Create a git-connected project with given parameters.

post

/integration/git/set

Body

branchstring

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[]

Tags to categorize and group project

gitobject

Responses

application/json

cURL

JavaScript

Python

HTTP

curl -L \
  --request POST \
  --url '<baseURL>/api/integration/git/set' \
  --header 'Content-Type: application/json' \
  --data '{"policy_id":"text","project_name":"my-project","tags":[null],"git":{"url":"text"}}'

200

400

403

scan_limit_not_exceeded

scan_limit_exceeded

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

Successful response

Create a GitHub connected project

Create a GitHub-connected project with given parameters.

post

/integration/github/set

Body

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

GitHub repository id and name combined as string concatenated.

Example: repo_name:1234id

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

typestring · enumrequired

Repositories view information (public or private)

Options: public, private

tagsstring[]

Tags to categorize and group projects

Responses

application/json

cURL

JavaScript

Python

HTTP

curl -L \
  --request POST \
  --url '<baseURL>/api/integration/github/set' \
  --header 'Content-Type: application/json' \
  --data '{"repoId":"repo_name:1234id","account":"text","branch":"main","policy_id":"text","type":"public","tags":[null]}'

200

400

403

scan_limit_exceeded

scan_limit_not_exceeded

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

Successful response

Create a GitLab connected project

Create a GitLab-connected project with given parameters.

post

/integration/gitlab/set

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

accountstring · ${gitlab.account.id}required

Related repository owner's GitLab login

policy_idstringrequired

Project's default policy for standard analysis

typestring · enumrequired

Repositories view information (public or private)

Options: public, private

tagsstring[]

Tags to categorize and group projects

Responses

application/json

cURL

JavaScript

Python

HTTP

curl -L \
  --request POST \
  --url '<baseURL>/api/integration/gitlab/set' \
  --header 'Content-Type: application/json' \
  --data '{"repoId":"repo_name:1234id","branch":"main","account":"text","policy_id":"text","type":"public","tags":[null]}'

200

400

403

scan_limit_exceeded

scan_limit_not_exceeded

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

Successful response

Create a Azure connected project

Create a Azure-connected project with given parameters.

post

/integration/azure/set

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

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}

It will required only importing tfvc project.

typestring · enumrequired

Repositories source control type

Options: TfsGit, TfsVersionControl, git, tfs

tagsstring[]

Tags to categorize and group projects

Responses

application/json

cURL

JavaScript

Python

HTTP

curl -L \
  --request POST \
  --url '<baseURL>/api/integration/azure/set' \
  --header 'Content-Type: application/json' \
  --data '{"repoId":"repo_name:1234id:projId | item_name:item_id","branch":"main","account":"text","policy_id":"text","type":"TfsGit","tags":[null]}'

200

400

403

scan_limit_exceeded

scan_limit_not_exceeded

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

Successful response

Create a Bitbucket connected project

Create a Bitbucket connected project with given parameters.

post

/integration/bitbucket/set

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

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

workspacestring

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

Example: my-workspace

typestring · enumrequired

Repository view information.

Example: public

Options: public, private, Bitbucket Server Project, Bitbucket Server User

tagsstring[]

Tags to categorize and group projects.

Example: [tag1, tag2]

Responses

application/json

cURL

JavaScript

Python

HTTP

curl -L \
  --request POST \
  --url '<baseURL>/api/integration/bitbucket/set?server=true' \
  --header 'Content-Type: application/json' \
  --data '{"repository":"my-repo","projectName":"my-repo_my-repo","projectKey":"PROJKEY","account":"my-project","policy_id":"7xoPVRFf6l86","branch":"main","workspace":"my-workspace","type":"public","tags":"[tag1, tag2]"}'

200

400

Project created but scan not started

Project created and scan started

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

Successful response

Trigger an existing Azure project scan

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

post

/integration/azure/start

Body

projectstringrequired

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.

Responses

application/json

cURL

JavaScript

Python

HTTP

curl -L \
  --request POST \
  --url '<baseURL>/api/integration/azure/start' \
  --header 'Content-Type: application/json' \
  --data '{"project":"text"}'

200

400

403

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

Successful response

Trigger an existing Bitbucket project scan

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

post

/integration/bitbucket/start

Body

projectstringrequired

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.

Responses

application/json

cURL

JavaScript

Python

HTTP

curl -L \
  --request POST \
  --url '<baseURL>/api/integration/bitbucket/start' \
  --header 'Content-Type: application/json' \
  --data '{"project":"text"}'

200

400

403

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

Successful response

Trigger an existing Git project scan

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

post

/integration/git/start

Body

projectstringrequired

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.

Responses

application/json

cURL

JavaScript

Python

HTTP

curl -L \
  --request POST \
  --url '<baseURL>/api/integration/git/start' \
  --header 'Content-Type: application/json' \
  --data '{"project":"text"}'

200

400

403

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

Successful response

Trigger an existing Github project scan

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

post

/integration/github/start

Body

projectstringrequired

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.

Responses

application/json

cURL

JavaScript

Python

HTTP

curl -L \
  --request POST \
  --url '<baseURL>/api/integration/github/start' \
  --header 'Content-Type: application/json' \
  --data '{"project":"text"}'

200

400

403

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

Successful response

Trigger an existing Gitlab project scan

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

post

/integration/gitlab/start

Body

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.

Responses

application/json

cURL

JavaScript

Python

HTTP

curl -L \
  --request POST \
  --url '<baseURL>/api/integration/gitlab/start' \
  --header 'Content-Type: application/json'

200

400

403

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

Successful response