Sign in

v1

latestOpenAPI 3.0.32026-07-26233989.2 KB
Analysis

Start Analysis

Initiates a background analysis task for a repository

post/api/analysis/start

Request body

repostring required

Repository identifier (format varies by service)

commit_idstring required

Git commit SHA or identifier

access_tokenstring required

Authentication token for the service

service'github' | 'azuredevops' | 'gitlab' | 'bitbucket' required

Version control service provider

branchstring

Git branch name

include_filesstring

Comma-separated file patterns to include in analysis

exclude_filesstring

Comma-separated file patterns to exclude from analysis

Example request

{
  "repo": "owner/repository",
  "commit_id": "abc123def456",
  "access_token": "ghp_xxxxxxxxxxxx",
  "service": "github",
  "branch": "main",
  "include_files": "src/**/*.py,lib/**/*.js,app/**/*.ts",
  "exclude_files": "tests/**,node_modules/**,dist/**"
}

Response

Analysis successfully started

messagestring

Success message