Lomo CodeSecurity

The API reference is in English.

Immutable source snapshot

DELETE /runs/{run_id}

Cancel run. Permissions, parameters, responses and examples.

0.1.0 · source bccff29 · Current reference · Download OpenAPI specification

Private service protocols are unsupported for external integration. Their schemas describe source declarations; they are not public service endpoints.

Read pinned handler: services/scanner/kodesec_scanner/main.py:1596

Cancel run

Cancel run through DELETE /runs/{run_id}. The parameters and declared response shapes below come from this exact source snapshot.

Internal protocol; unsupported for external integration. This page makes no request to a local installation.

Authority

Private service protocol. No public or third-party integration authority.

Inspect the authority source · Authentication guide

Parameters and headers

NameLocationContract
run_idpath
Required

string

Schema
{
  "format": "uuid",
  "title": "Run Id",
  "type": "string"
}
request_digestquery
Conditional / optional

string | null

Schema
{
  "anyOf": [
    {
      "type": "string"
    },
    {
      "type": "null"
    }
  ],
  "title": "Request Digest"
}
result_digestquery
Conditional / optional

string | null

Schema
{
  "anyOf": [
    {
      "type": "string"
    },
    {
      "type": "null"
    }
  ],
  "title": "Result Digest"
}

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
202

Successful Response

application/json · RunStateResponse
{
  "additionalProperties": false,
  "properties": {
    "created_at": {
      "format": "date-time",
      "title": "Created At",
      "type": "string"
    },
    "deadline_at": {
      "format": "date-time",
      "title": "Deadline At",
      "type": "string"
    },
    "error_code": {
      "anyOf": [
        {
          "type": "string"
        },
        {
          "type": "null"
        }
      ],
      "title": "Error Code"
    },
    "error_detail": {
      "anyOf": [
        {
          "type": "string"
        },
        {
          "type": "null"
        }
      ],
      "title": "Error Detail"
    },
    "expires_at": {
      "anyOf": [
        {
          "format": "date-time",
          "type": "string"
        },
        {
          "type": "null"
        }
      ],
      "title": "Expires At"
    },
    "finished_at": {
      "anyOf": [
        {
          "format": "date-time",
          "type": "string"
        },
        {
          "type": "null"
        }
      ],
      "title": "Finished At"
    },
    "request_digest": {
      "pattern": "^[0-9a-f]{64}$",
      "title": "Request Digest",
      "type": "string"
    },
    "result_available": {
      "default": false,
      "title": "Result Available",
      "type": "boolean"
    },
    "result_manifest": {
      "anyOf": [
        {
          "$ref": "#/components/schemas/RunResultManifest"
        },
        {
          "type": "null"
        }
      ]
    },
    "run_id": {
      "format": "uuid",
      "title": "Run Id",
      "type": "string"
    },
    "started_at": {
      "anyOf": [
        {
          "format": "date-time",
          "type": "string"
        },
        {
          "type": "null"
        }
      ],
      "title": "Started At"
    },
    "status": {
      "enum": [
        "queued",
        "running",
        "cancelling",
        "completed",
        "failed",
        "cancelled"
      ],
      "title": "Status",
      "type": "string"
    }
  },
  "required": [
    "run_id",
    "request_digest",
    "status",
    "created_at",
    "deadline_at"
  ],
  "title": "RunStateResponse",
  "type": "object"
}
404

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

409

Refresh current revision and identity. A conflicting command must not be blindly repeated. 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"
}

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.

5 source error observations
StatusSource detailRecovery
422 ↗request_digest must be a lowercase SHA-256 digestCorrect the field or semantic validation error. Input values are omitted from control validation errors.
422 ↗result_digest must be a lowercase SHA-256 digestCorrect the field or semantic validation error. Input values are omitted from control validation errors.
422 ↗result_digest requires request_digestCorrect the field or semantic validation error. Input values are omitted from control validation errors.
404 ↗scanner run was not found or its recovery window expiredRefresh the collection and verify the resource identity before retrying.
409 ↗{"code":"run_id_conflict","message":"run_id is already bound to a different request"}Refresh current revision and identity. A conflicting command must not be blindly repeated.

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 202 JSON
{
  "created_at": "2026-01-01T00:00:00Z",
  "deadline_at": "2026-01-01T00:00:00Z",
  "request_digest": "0000000000000000000000000000000000000000000000000000000000000000",
  "run_id": "00000000-0000-4000-8000-000000000001",
  "status": "queued"
}
Download this service's complete OpenAPI

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