Lomo CodeSecurity

The API reference is in English.

Immutable source snapshot

GET /v1/scans/{scan_id}/summary

Get scan summary. Permissions, parameters, responses and examples.

0.1.0 · source bccff29 · Current reference · Download OpenAPI specification

This address preserves one reviewed source snapshot. Use the current entry point for the selected documentation version.

Read pinned handler: apps/api/kodesec_api/main.py:4914

Get scan summary

Get scan summary through GET /v1/scans/{scan_id}/summary. The parameters and declared response shapes below come from this exact source snapshot.

Source preview; no stable third-party integration promise. This page makes no request to a local installation.

Authority

Browser operator session or exact IDE capability with scan:read. Route-specific ownership and generation checks also apply.

Inspect the authority source · Authentication guide

Parameters and headers

NameLocationContract
scan_idpath
Required

integer

Schema
{
  "title": "Scan Id",
  "type": "integer"
}

Request body

No typed JSON body is declared by this handler. That does not rule out source-level request parsing; inspect the pinned implementation, especially for internal connector protocols.

Responses

StatusMeaning and declared shape
200

Successful Response

application/json · ScanSummaryOut
{
  "properties": {
    "findings": {
      "$ref": "#/components/schemas/ScanFindingCountsOut"
    },
    "findings_revision": {
      "minimum": 1,
      "title": "Findings Revision",
      "type": "integer"
    },
    "revision": {
      "minimum": 1,
      "title": "Revision",
      "type": "integer"
    },
    "scan": {
      "$ref": "#/components/schemas/ScanSummaryResourceOut"
    }
  },
  "required": [
    "scan",
    "findings",
    "revision",
    "findings_revision"
  ],
  "title": "ScanSummaryOut",
  "type": "object"
}
400

Exact host, malformed request or URL credential refusal

application/json · object
{
  "properties": {
    "detail": {
      "type": "string"
    }
  },
  "required": [
    "detail"
  ],
  "type": "object"
}
401

Missing or invalid membership

application/json · object
{
  "properties": {
    "detail": {
      "type": "string"
    }
  },
  "required": [
    "detail"
  ],
  "type": "object"
}
403

Exact origin, CSRF or route authority refusal

application/json · object
{
  "properties": {
    "detail": {
      "type": "string"
    }
  },
  "required": [
    "detail"
  ],
  "type": "object"
}
404

Refresh the collection and verify the resource identity before retrying. See source-linked error catalog.

422

Validation Error

application/json · HTTPValidationError
{
  "properties": {
    "detail": {
      "items": {
        "$ref": "#/components/schemas/ValidationError"
      },
      "title": "Detail",
      "type": "array"
    }
  },
  "title": "HTTPValidationError",
  "type": "object"
}
429

Authentication rate or connection limit

application/json · object
{
  "properties": {
    "detail": {
      "type": "string"
    }
  },
  "required": [
    "detail"
  ],
  "type": "object"
}

An empty or broad schema preserves the source contract. It is not a promise of an empty response.

Source-linked errors

Literal HTTP errors in this handler and same-file helper call graph, plus control middleware. Dynamic and cross-module failures may add other errors; source links are authoritative.

1 source error observations
StatusSource detailRecovery
404 ↗scan not foundRefresh the collection and verify the resource identity before retrying.

Read the recovery guide

Synthetic examples

These examples validate declared JSON shapes and formats. They contain no real installation data and do not prove runtime admission, cross-field validation, authority or successful work.

Response 200 JSON
{
  "findings": {
    "active": 1,
    "gate_exempt": 1,
    "scanner_counts": {},
    "severity_counts": {},
    "suppressed": 1,
    "total": 1
  },
  "findings_revision": 1,
  "revision": 1,
  "scan": {
    "completed_at": "2026-01-01T00:00:00Z",
    "created_at": "2026-01-01T00:00:00Z",
    "duration_ms": 1,
    "error": "synthetic",
    "gate_decision": "synthetic",
    "gate_reasons": [],
    "id": 1,
    "mode": "synthetic",
    "project_id": 1,
    "started_at": "2026-01-01T00:00:00Z",
    "status": "synthetic"
  }
}
Download this service's complete OpenAPI

All referenced models remain in its components section. Browse control model definitions.