Skip to main content
POST
/
api
/
analysis
/
results
/
full_report
curl --request POST \
  --url https://api.codeant.ai/api/analysis/results/full_report \
  --header 'Content-Type: application/json' \
  --data '
{
  "repo": "owner/repository",
  "commit_id": "abc123def456",
  "access_token": "ghp_xxxxxxxxxxxx",
  "service": "github",
  "branch": "main",
  "fields": [
    "Static Application Security Testing (SAST)",
    "Secrets",
    "Software Composition Analysis (SCA)",
    "Infrastructure as Code"
  ]
}
'
{
  "report_url": "https://storage.example.com/reports/owner-repository-abc123def456.html",
  "status": "success",
  "commit_id": "abc123def456",
  "branch": "main"
}

Body

application/json
​
repo
string
required

Repository identifier (format varies by service)

Example:

"owner/repository"

​
commit_id
string
required

Git commit SHA or identifier

Example:

"abc123def456"

​
access_token
string
required

Authentication token for the service

Example:

"ghp_xxxxxxxxxxxx"

​
service
enum<string>
required

Version control service provider

Available options:
github,
azuredevops,
gitlab,
bitbucket
Example:

"github"

​
branch
string
default:main

Git branch name

Example:

"main"

​
fields
enum<string>[]

List of analysis fields to include in the report

Available options:
Static Application Security Testing (SAST),
Secrets,
Software Composition Analysis (SCA),
Infrastructure as Code
Example:
[
  "Static Application Security Testing (SAST)",
  "Secrets",
  "Software Composition Analysis (SCA)",
  "Infrastructure as Code"
]
​
gitlab_base_url
string
default:https://gitlab.com

Base URL for GitLab service (optional)

Example:

"https://gitlab.com"

​
github_base_url
string
default:https://github.com

Base URL for GitHub service (optional)

Example:

"https://github.com"

​
azure_devops_base_url
string
default:https://dev.azure.com

Base URL for Azure DevOps service (optional)

Example:

"https://dev.azure.com"

​
bitbucket_base_url
string
default:https://api.bitbucket.org/2.0

Base URL for Bitbucket service (optional)

Example:

"https://api.bitbucket.org/2.0"

Response

Full report generated successfully

Full analysis report response containing the report URL and status

​
report_url
string

URL to access the generated HTML report

Example:

"https://storage.example.com/reports/owner-repository-abc123def456.html"

​
status
enum<string>

Status of the report generation

Available options:
success,
failed
Example:

"success"

​
commit_id
string

Git commit SHA that was analyzed

Example:

"abc123def456"

​
branch
string

Git branch name that was analyzed

Example:

"main"