Get scan details

GET

scans

{scanId}

Error

A valid request URL is required to generate request examples

{
  "created_at": "2023-11-07T05:31:56Z",
  "id": "3c90c3cc-0d44-4b50-8888-8dd25736052a",
  "status": "pending",
  "title": "<string>",
  "user_id": "<string>",
  "auth_checked_at": "2023-11-07T05:31:56Z",
  "auth_detail": "<string>",
  "auth_failure_code": "<string>",
  "auth_status": "<string>",
  "cloud_connection_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"
    }
  ],
  "completed_at": "2023-11-07T05:31:56Z",
  "connector_id": "<string>",
  "domain_ids": [
    "3c90c3cc-0d44-4b50-8888-8dd25736052a"
  ],
  "duration": "<string>",
  "executive_summary": "<string>",
  "findings": {
    "total": 123,
    "critical": 123,
    "high": 123,
    "medium": 123,
    "low": 123
  },
  "is_retest": true,
  "knowledge_resource_pins": [
    {
      "connection_id": "<string>",
      "page_id": "<string>",
      "label": "<string>",
      "url": "<string>",
      "guidance": "<string>"
    }
  ],
  "live_prompt_enabled": true,
  "live_prompt_ready": true,
  "max_budget_usd": 123,
  "budget_policy": "stop",
  "methodology": "<string>",
  "org_knowledge_enabled": true,
  "parent_scan_id": "<string>",
  "parent_scan_title": "<string>",
  "recommendations": "<string>",
  "repositories": [
    {
      "url": "<string>",
      "branch": "<string>",
      "provider": "<string>"
    }
  ],
  "repository_ids": [
    "3c90c3cc-0d44-4b50-8888-8dd25736052a"
  ],
  "repository_commits": {},
  "retest_source": {
    "id": "<string>",
    "title": "<string>",
    "severity": "critical",
    "status": "open"
  },
  "retest_source_scan_id": "<string>",
  "retest_source_vulnerability_id": "<string>",
  "retest_target_count": 123,
  "scan_tier": "lite",
  "scan_type": "whitebox",
  "schedule_id": "<string>",
  "stop_reason": "budget_exceeded",
  "status_detail": "<string>",
  "status_detail_code": "sandbox_pending",
  "technical_analysis": "<string>",
  "updated_at": "2023-11-07T05:31:56Z",
  "urls": [
    "<string>"
  ],
  "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>"
      },
      "latest_retest": {
        "scan_id": "<string>",
        "outcome": "running",
        "inconclusive_reason": "<string>",
        "started_at": "2023-11-07T05:31:56Z"
      },
      "fix_pr_eligible": true,
      "fix_pr_reason": "<string>",
      "fix_pr_url": "<string>",
      "cvss_adjustment": {
        "breakdown": {
          "attack_vector": "N",
          "attack_complexity": "L",
          "privileges_required": "N",
          "user_interaction": "N",
          "scope": "U",
          "confidentiality": "N",
          "integrity": "N",
          "availability": "N"
        },
        "score": 123,
        "vector": "<string>",
        "severity": "critical",
        "reason": "<string>",
        "adjusted_by": "<string>",
        "adjusted_at": "2023-11-07T05:31:56Z",
        "original": {
          "score": 123,
          "vector": "<string>",
          "severity": "<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.

created_at

string<date-time>

required

string<uuid>

required

status

enum<string>

required

Available options:

pending,

running,

completed,

failed,

cancelled

title

string

required

user_id

string

required

auth_checked_at

string<date-time> | null

auth_detail

string | null

Short, secret-free explanation of the login outcome.

auth_failure_code

string | null

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

auth_status

string | null

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

cloud_connection_checked_at

string<date-time> | null

Time when the orchestrator checked the selected cloud connections.

cloud_connection_status

object[] | null

Attachment outcome for each cloud connection selected for the scan.

Show child attributes

completed_at

string<date-time>

connector_id

string | null

domain_ids

string<uuid>[]

duration

string | null

executive_summary

string

findings

object

Show child attributes

is_retest

boolean

True for a retest scan. A retest scan verifies one or more existing issues and does not appear in the scan list.

knowledge_resource_pins

object[] | null

Public provider-resource metadata selected specifically for this scan.

Show child attributes

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.

budget_policy

enum<string> | null

Self-hosted only: cost-limit policy the scan runs with, if a limit was set.

Available options:

stop,

pause,

null

methodology

string

org_knowledge_enabled

boolean | null

parent_scan_id

string | null

Retest scans only: the scan that found the source issue.

parent_scan_title

string | null

Retest scans only: the title of the parent scan.

recommendations

string

repositories

object[]

Show child attributes

repository_ids

string<uuid>[]

repository_commits

object | null

The commit each repository was tested at, keyed by the repository URL from repositories. The value is the full commit SHA that the scan checked out. Null for a scan with no repository target and for a scan that ran before Strix recorded commits.

Show child attributes

retest_source

object | null

Retest scans that a Retest issue request started: the current state of that issue. Null for a retest that a rerun started, even when retest_target_count is 1.

Show child attributes

retest_source_scan_id

string | null

Retest scans that a rerun started: the scan whose open issues the retest verifies.

retest_source_vulnerability_id

string | null

Retest scans that a Retest issue request started: the issue that the retest verifies. Null for a retest that a rerun started, even when retest_target_count is 1.

retest_target_count

integer

Retest scans only: the number of issues that the retest verifies. 0 for other scans.

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

scan_type

enum<string>

Available options:

whitebox,

blackbox

schedule_id

string | null

stop_reason

enum<string> | null

Why the engine ended the scan before its agents finished: the cost limit was reached, the model provider rate-limited the scan, or a sub-agent never finished. Null when the agents finished on their own. A retest scan that stopped early does not mark any issue fixed; its issues without a finding are inconclusive.

Available options:

budget_exceeded,

rate_limited,

agents_incomplete,

null

status_detail

string | null

Secret-free explanation of status_detail_code. Self-hosted installs return the exact infrastructure message, for example the Kubernetes scheduler message. The hosted product returns generic wording. For budget_near_limit every install returns the cost figures, for example The run used $96.13 of its $100.00 cost limit (96%)….

status_detail_code

enum<string> | null

Reason code behind the current status. Set when the launch path or the infrastructure set the status, or when a completed scan ended early near its cost limit (budget_near_limit). null for an ordinary engine-owned status.

Available options:

sandbox_pending,

config_missing,

llm_not_configured,

secrets_missing,

connector_unavailable,

credentials_unreadable,

image_pull_failed,

pod_unschedulable,

pod_rejected,

container_config_failed,

volume_failed,

sandbox_ended,

sandbox_timeout,

docker_unavailable,

sandbox_create_failed,

launch_failed,

retest_already_running,

watchdog_timeout,

launch_no_telemetry,

relaunch_failed,

relaunches_exhausted,

engine_failed,

budget_near_limit

technical_analysis

string

updated_at

string<date-time>

urls

string[]

vulnerabilities

object[]

Show child attributes

cloud_connections

object[]

Show child attributes

Error

A valid request URL is required to generate request examples

{
  "created_at": "2023-11-07T05:31:56Z",
  "id": "3c90c3cc-0d44-4b50-8888-8dd25736052a",
  "status": "pending",
  "title": "<string>",
  "user_id": "<string>",
  "auth_checked_at": "2023-11-07T05:31:56Z",
  "auth_detail": "<string>",
  "auth_failure_code": "<string>",
  "auth_status": "<string>",
  "cloud_connection_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"
    }
  ],
  "completed_at": "2023-11-07T05:31:56Z",
  "connector_id": "<string>",
  "domain_ids": [
    "3c90c3cc-0d44-4b50-8888-8dd25736052a"
  ],
  "duration": "<string>",
  "executive_summary": "<string>",
  "findings": {
    "total": 123,
    "critical": 123,
    "high": 123,
    "medium": 123,
    "low": 123
  },
  "is_retest": true,
  "knowledge_resource_pins": [
    {
      "connection_id": "<string>",
      "page_id": "<string>",
      "label": "<string>",
      "url": "<string>",
      "guidance": "<string>"
    }
  ],
  "live_prompt_enabled": true,
  "live_prompt_ready": true,
  "max_budget_usd": 123,
  "budget_policy": "stop",
  "methodology": "<string>",
  "org_knowledge_enabled": true,
  "parent_scan_id": "<string>",
  "parent_scan_title": "<string>",
  "recommendations": "<string>",
  "repositories": [
    {
      "url": "<string>",
      "branch": "<string>",
      "provider": "<string>"
    }
  ],
  "repository_ids": [
    "3c90c3cc-0d44-4b50-8888-8dd25736052a"
  ],
  "repository_commits": {},
  "retest_source": {
    "id": "<string>",
    "title": "<string>",
    "severity": "critical",
    "status": "open"
  },
  "retest_source_scan_id": "<string>",
  "retest_source_vulnerability_id": "<string>",
  "retest_target_count": 123,
  "scan_tier": "lite",
  "scan_type": "whitebox",
  "schedule_id": "<string>",
  "stop_reason": "budget_exceeded",
  "status_detail": "<string>",
  "status_detail_code": "sandbox_pending",
  "technical_analysis": "<string>",
  "updated_at": "2023-11-07T05:31:56Z",
  "urls": [
    "<string>"
  ],
  "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>"
      },
      "latest_retest": {
        "scan_id": "<string>",
        "outcome": "running",
        "inconclusive_reason": "<string>",
        "started_at": "2023-11-07T05:31:56Z"
      },
      "fix_pr_eligible": true,
      "fix_pr_reason": "<string>",
      "fix_pr_url": "<string>",
      "cvss_adjustment": {
        "breakdown": {
          "attack_vector": "N",
          "attack_complexity": "L",
          "privileges_required": "N",
          "user_interaction": "N",
          "scope": "U",
          "confidentiality": "N",
          "integrity": "N",
          "availability": "N"
        },
        "score": 123,
        "vector": "<string>",
        "severity": "critical",
        "reason": "<string>",
        "adjusted_by": "<string>",
        "adjusted_at": "2023-11-07T05:31:56Z",
        "original": {
          "score": 123,
          "vector": "<string>",
          "severity": "<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>"
}

Analytics

Asset Discovery

Audit

Billing

Chat

CLI

Connectors

Containers

Assets

Test Users

Integrations

Knowledge

License

LLM

Run Logs

Organization

Invitations

Members

PR Reviews

Vulnerabilities

Supply Chain

Scans

Schedules

Search

Tokens

Uploads

Webhooks

Workspaces

Repositories

Get scan details

Authorizations

Path Parameters

Response