Get scan details

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>",
  "status": "pending",
  "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>",
  "scan_type": "whitebox",
  "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,
  "max_budget_usd": 123,
  "auth_status": "<string>",
  "auth_failure_code": "<string>",
  "auth_detail": "<string>",
  "auth_checked_at": "2023-11-07T05:31:56Z",
  "cloud_connection_status": [
    {
      "connection_id": "<string>",
      "provider": "<string>",
      "name": "<string>",
      "status": "attached",
      "tool_count": 123,
      "reason": "not_ready"
    }
  ],
  "cloud_connection_checked_at": "2023-11-07T05:31:56Z",
  "scan_tier": "lite",
  "vulnerabilities": [
    {
      "id": "<string>",
      "title": "<string>",
      "description": "<string>",
      "created_at": "2023-11-07T05:31:56Z",
      "status": "open",
      "severity": "critical",
      "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>",
      "fix_effort": "trivial",
      "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>",
      "original_severity": "critical",
      "severity_changed_at": "2023-11-07T05:31:56Z",
      "severity_changed_by": "<string>",
      "severity_override_reason": "<string>",
      "retest_of_vulnerability_id": "<string>",
      "display_number": 123,
      "location_meta": {
        "branch": "<string>",
        "provider": "<string>",
        "repo_url": "<string>"
      },
      "fix_pr_eligible": true,
      "fix_pr_reason": "<string>",
      "fix_pr_url": "<string>"
    }
  ],
  "cloud_connections": [
    {
      "id": "3c90c3cc-0d44-4b50-8888-8dd25736052a",
      "slug": "<string>",
      "provider": "<string>",
      "label": "<string>",
      "account": "<string>",
      "notes": "<string>",
      "applies_to_domain_ids": [
        "3c90c3cc-0d44-4b50-8888-8dd25736052a"
      ],
      "applies_to_repository_ids": [
        "3c90c3cc-0d44-4b50-8888-8dd25736052a"
      ],
      "project_name": "<string>",
      "tool_hint": "<string>"
    }
  ]
}

{
  "detail": "<string>",
  "code": "<string>",
  "required_scope": "scans:read",
  "docs": "<string>",
  "hint": "<string>"
}

{
  "detail": "<string>",
  "code": "<string>",
  "required_scope": "scans:read",
  "docs": "<string>",
  "hint": "<string>"
}

{
  "detail": "<string>",
  "code": "<string>",
  "required_scope": "scans:read",
  "docs": "<string>",
  "hint": "<string>"
}

{
  "detail": "<string>",
  "code": "<string>",
  "required_scope": "scans:read",
  "docs": "<string>",
  "hint": "<string>"
}

Authorizations

Authorization

string

header

required

API token obtained from the Tokens endpoint or CLI device login. Include as Authorization: Bearer <token>. Requests made with a managed CLI session also include X-Strix-Workspace: <organization_id> to pin a process to the workspace it started in; recovery endpoints report the current workspace after a concurrent switch.

Path Parameters

scanId

string<uuid>

required

UUID of the scan. Use the id field of a scan from listScans.

Response

Scan details with vulnerabilities.

string<uuid>

required

user_id

string

required

title

string

required

status

enum<string>

required

Available options:

pending,

running,

completed,

failed,

cancelled

created_at

string<date-time>

required

urls

string[]

repositories

object[]

Show child attributes

domain_ids

string<uuid>[]

repository_ids

string<uuid>[]

schedule_id

string | null

scan_type

enum<string>

Available options:

whitebox,

blackbox

connector_id

string | null

is_retest

boolean

updated_at

string<date-time>

completed_at

string<date-time>

duration

string | null

executive_summary

string

methodology

string

technical_analysis

string

recommendations

string

findings

object

Show child attributes

org_knowledge_enabled

boolean | null

live_prompt_enabled

boolean

live_prompt_ready

boolean

max_budget_usd

number | null

Self-hosted only: per-scan LLM cost limit (USD), if one was set.

auth_status

string | null

Whether the agent could log in with the provisioned test credentials, when any were configured: succeeded | failed.

auth_failure_code

string | null

Category of the login failure (e.g. invalid_credentials, mfa_required_not_configured).

auth_detail

string | null

Short, secret-free explanation of the login outcome.

auth_checked_at

string<date-time> | null

cloud_connection_status

object[] | null

Attachment outcome for each cloud connection selected for the scan.

Show child attributes

cloud_connection_checked_at

string<date-time> | null

Time when the orchestrator checked the selected cloud connections.

scan_tier

enum<string> | null

Scan tier the run used. A null value means the scan was launched without a tier.

Available options:

lite,

standard,

ultra,

null

vulnerabilities

object[]

Show child attributes

cloud_connections

object[]

Show child attributes

Error

A valid request URL is required to generate request examples

{
  "id": "3c90c3cc-0d44-4b50-8888-8dd25736052a",
  "user_id": "<string>",
  "title": "<string>",
  "status": "pending",
  "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>",
  "scan_type": "whitebox",
  "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,
  "max_budget_usd": 123,
  "auth_status": "<string>",
  "auth_failure_code": "<string>",
  "auth_detail": "<string>",
  "auth_checked_at": "2023-11-07T05:31:56Z",
  "cloud_connection_status": [
    {
      "connection_id": "<string>",
      "provider": "<string>",
      "name": "<string>",
      "status": "attached",
      "tool_count": 123,
      "reason": "not_ready"
    }
  ],
  "cloud_connection_checked_at": "2023-11-07T05:31:56Z",
  "scan_tier": "lite",
  "vulnerabilities": [
    {
      "id": "<string>",
      "title": "<string>",
      "description": "<string>",
      "created_at": "2023-11-07T05:31:56Z",
      "status": "open",
      "severity": "critical",
      "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>",
      "fix_effort": "trivial",
      "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>",
      "original_severity": "critical",
      "severity_changed_at": "2023-11-07T05:31:56Z",
      "severity_changed_by": "<string>",
      "severity_override_reason": "<string>",
      "retest_of_vulnerability_id": "<string>",
      "display_number": 123,
      "location_meta": {
        "branch": "<string>",
        "provider": "<string>",
        "repo_url": "<string>"
      },
      "fix_pr_eligible": true,
      "fix_pr_reason": "<string>",
      "fix_pr_url": "<string>"
    }
  ],
  "cloud_connections": [
    {
      "id": "3c90c3cc-0d44-4b50-8888-8dd25736052a",
      "slug": "<string>",
      "provider": "<string>",
      "label": "<string>",
      "account": "<string>",
      "notes": "<string>",
      "applies_to_domain_ids": [
        "3c90c3cc-0d44-4b50-8888-8dd25736052a"
      ],
      "applies_to_repository_ids": [
        "3c90c3cc-0d44-4b50-8888-8dd25736052a"
      ],
      "project_name": "<string>",
      "tool_hint": "<string>"
    }
  ]
}

{
  "detail": "<string>",
  "code": "<string>",
  "required_scope": "scans:read",
  "docs": "<string>",
  "hint": "<string>"
}

{
  "detail": "<string>",
  "code": "<string>",
  "required_scope": "scans:read",
  "docs": "<string>",
  "hint": "<string>"
}

{
  "detail": "<string>",
  "code": "<string>",
  "required_scope": "scans:read",
  "docs": "<string>",
  "hint": "<string>"
}

{
  "detail": "<string>",
  "code": "<string>",
  "required_scope": "scans:read",
  "docs": "<string>",
  "hint": "<string>"
}

Scans

Audit

Vulnerabilities

Assets

Schedules

Tokens

Webhooks

Organization

Members

Invitations

Analytics

LLM

Connectors

Chat

PR Reviews

Knowledge

Integrations

Uploads

Test Users

License

Supply Chain

CLI

Billing

Workspaces

Get scan details

Authorizations

Path Parameters

Response