v1

latestOpenAPI 3.0.32026-07-26233989.2 KB

Analysis

Get Secrets Scan Results

Retrieves the secrets scanning results for a specific repository and commit

post/api/analysis/results/secrets

Request body

repostring required

Repository identifier (format varies by service)

commit_idstring

Git commit SHA or identifier. Either commit_id or branch is required. If both are provided, commit_id takes precedence.

branchstring

Git branch name. When provided without commit_id, the service resolves the latest commit from scan history for this branch. Either commit_id or branch is required.

access_tokenstring required

Authentication token for the service

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

Version control service provider

gitlab_base_urlstring

Base URL for the service (optional for GitHub, required for GitLab)

Example request

{
  "repo": "owner/repository",
  "commit_id": "abc123def456",
  "branch": "main",
  "access_token": "ghp_xxxxxxxxxxxx",
  "service": "github",
  "gitlab_base_url": "https://gitlab.com"
}

Response

Secrets scan results retrieved successfully

status'pending' | 'processing' | 'done' | 'failed'

Status of the secrets scan

commit_idstring

Git commit SHA that was analyzed

Example response

{
  "results": {
    "secrets": [
      {
        "type": "Secret Keyword",
        "filename": "/mnt/lambda/owner/repository/abc123def456/src/config.py",
        "hashed_secret": "9d4e1e23bd5b727046a9e3b4b7db57bd8d6ee684",
        "line_number": 14,
        "confidence_score": "FALSE_POSITIVE"
      }
    ],
    "secretsCount": 1
  },
  "status": "done",
  "commit_id": "abc123def456"
}