Scans
Get scan details
Returns full scan details including associated vulnerabilities.
GET
/
scans
/
{scanId}
Error
A valid request URL is required to generate request examples{
"id": "3c90c3cc-0d44-4b50-8888-8dd25736052a",
"user_id": "<string>",
"title": "<string>",
"created_at": "2023-11-07T05:31:56Z",
"urls": [
"<string>"
],
"repositories": [
{
"url": "<string>",
"branch": "<string>",
"provider": "<string>"
}
],
"domain_ids": [
"3c90c3cc-0d44-4b50-8888-8dd25736052a"
],
"repository_ids": [
"3c90c3cc-0d44-4b50-8888-8dd25736052a"
],
"schedule_id": "<string>",
"connector_id": "<string>",
"is_retest": true,
"updated_at": "2023-11-07T05:31:56Z",
"completed_at": "2023-11-07T05:31:56Z",
"duration": "<string>",
"executive_summary": "<string>",
"methodology": "<string>",
"technical_analysis": "<string>",
"recommendations": "<string>",
"findings": {
"total": 123,
"critical": 123,
"high": 123,
"medium": 123,
"low": 123
},
"org_knowledge_enabled": true,
"live_prompt_enabled": true,
"live_prompt_ready": true,
"vulnerabilities": [
{
"id": "3c90c3cc-0d44-4b50-8888-8dd25736052a",
"title": "<string>",
"description": "<string>",
"created_at": "2023-11-07T05:31:56Z",
"scan_id": "3c90c3cc-0d44-4b50-8888-8dd25736052a",
"pr_review_id": "3c90c3cc-0d44-4b50-8888-8dd25736052a",
"cve": "<string>",
"cvss": 123,
"potential_risk_saving": 123,
"risk_saving_description": "<string>",
"impact": "<string>",
"endpoint": "<string>",
"method": "<string>",
"target": "<string>",
"technical_analysis": "<string>",
"poc_description": "<string>",
"poc_script_code": "<string>",
"code_diff": "<string>",
"code_file": "<string>",
"code_before": "<string>",
"code_after": "<string>",
"cwe": [
"<string>"
],
"code_locations": [
{
"file": "<string>",
"start_line": 123,
"end_line": 123,
"snippet": "<string>",
"label": "<string>",
"fix_before": "<string>",
"fix_after": "<string>"
}
],
"remediation_steps": "<string>",
"fix_pr_body": "<string>",
"evidence": "<string>",
"assumptions": "<string>",
"cvss_breakdown": {
"attack_vector": "<string>",
"attack_complexity": "<string>",
"privileges_required": "<string>",
"user_interaction": "<string>",
"scope": "<string>",
"confidentiality": "<string>",
"integrity": "<string>",
"availability": "<string>"
},
"status_changed_at": "2023-11-07T05:31:56Z",
"status_changed_by": "<string>",
"status_note": "<string>",
"severity_changed_at": "2023-11-07T05:31:56Z",
"severity_changed_by": "<string>",
"severity_override_reason": "<string>",
"retest_of_vulnerability_id": "3c90c3cc-0d44-4b50-8888-8dd25736052a",
"display_number": 123,
"location_meta": {
"branch": "<string>",
"provider": "<string>",
"repo_url": "<string>"
},
"fix_pr_eligible": true,
"fix_pr_reason": "<string>",
"fix_pr_url": "<string>"
}
]
}{
"detail": "<string>"
}{
"detail": "<string>"
}{
"detail": "<string>"
}Authorizations
API token obtained from the Tokens endpoint. Include as Authorization: Bearer <token>.
Path Parameters
Response
Scan details with vulnerabilities.
Available options:
pending, running, completed, failed, cancelled Show child attributes
Show child attributes
Available options:
whitebox, blackbox Show child attributes
Show child attributes
Show child attributes
Show child attributes
⌘I
Error
A valid request URL is required to generate request examples{
"id": "3c90c3cc-0d44-4b50-8888-8dd25736052a",
"user_id": "<string>",
"title": "<string>",
"created_at": "2023-11-07T05:31:56Z",
"urls": [
"<string>"
],
"repositories": [
{
"url": "<string>",
"branch": "<string>",
"provider": "<string>"
}
],
"domain_ids": [
"3c90c3cc-0d44-4b50-8888-8dd25736052a"
],
"repository_ids": [
"3c90c3cc-0d44-4b50-8888-8dd25736052a"
],
"schedule_id": "<string>",
"connector_id": "<string>",
"is_retest": true,
"updated_at": "2023-11-07T05:31:56Z",
"completed_at": "2023-11-07T05:31:56Z",
"duration": "<string>",
"executive_summary": "<string>",
"methodology": "<string>",
"technical_analysis": "<string>",
"recommendations": "<string>",
"findings": {
"total": 123,
"critical": 123,
"high": 123,
"medium": 123,
"low": 123
},
"org_knowledge_enabled": true,
"live_prompt_enabled": true,
"live_prompt_ready": true,
"vulnerabilities": [
{
"id": "3c90c3cc-0d44-4b50-8888-8dd25736052a",
"title": "<string>",
"description": "<string>",
"created_at": "2023-11-07T05:31:56Z",
"scan_id": "3c90c3cc-0d44-4b50-8888-8dd25736052a",
"pr_review_id": "3c90c3cc-0d44-4b50-8888-8dd25736052a",
"cve": "<string>",
"cvss": 123,
"potential_risk_saving": 123,
"risk_saving_description": "<string>",
"impact": "<string>",
"endpoint": "<string>",
"method": "<string>",
"target": "<string>",
"technical_analysis": "<string>",
"poc_description": "<string>",
"poc_script_code": "<string>",
"code_diff": "<string>",
"code_file": "<string>",
"code_before": "<string>",
"code_after": "<string>",
"cwe": [
"<string>"
],
"code_locations": [
{
"file": "<string>",
"start_line": 123,
"end_line": 123,
"snippet": "<string>",
"label": "<string>",
"fix_before": "<string>",
"fix_after": "<string>"
}
],
"remediation_steps": "<string>",
"fix_pr_body": "<string>",
"evidence": "<string>",
"assumptions": "<string>",
"cvss_breakdown": {
"attack_vector": "<string>",
"attack_complexity": "<string>",
"privileges_required": "<string>",
"user_interaction": "<string>",
"scope": "<string>",
"confidentiality": "<string>",
"integrity": "<string>",
"availability": "<string>"
},
"status_changed_at": "2023-11-07T05:31:56Z",
"status_changed_by": "<string>",
"status_note": "<string>",
"severity_changed_at": "2023-11-07T05:31:56Z",
"severity_changed_by": "<string>",
"severity_override_reason": "<string>",
"retest_of_vulnerability_id": "3c90c3cc-0d44-4b50-8888-8dd25736052a",
"display_number": 123,
"location_meta": {
"branch": "<string>",
"provider": "<string>",
"repo_url": "<string>"
},
"fix_pr_eligible": true,
"fix_pr_reason": "<string>",
"fix_pr_url": "<string>"
}
]
}{
"detail": "<string>"
}{
"detail": "<string>"
}{
"detail": "<string>"
}