Lomo CodeSecurity

The API reference is in English.

Internal implementation reference

GET /operations/{operation_id}

Get operation. Permissions, parameters, responses and examples.

0.1.0 · source bccff29 · Immutable snapshot · 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/updater_routes.py:72

Get operation

Get operation through GET /operations/{operation_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
operation_idpath
Required

string

Schema
{
  "format": "uuid",
  "title": "Operation Id",
  "type": "string"
}
X-KodeSec-Request-Digestheader
Conditional / optional

string | null

Schema
{
  "anyOf": [
    {
      "type": "string"
    },
    {
      "type": "null"
    }
  ],
  "title": "X-Kodesec-Request-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
200

Successful Response

application/json · OperationRecord
{
  "additionalProperties": false,
  "properties": {
    "activity": {
      "anyOf": [
        {
          "$ref": "#/components/schemas/OperationActivity"
        },
        {
          "type": "null"
        }
      ]
    },
    "attempt": {
      "maximum": 3,
      "minimum": 1,
      "title": "Attempt",
      "type": "integer"
    },
    "cancel_requested_at": {
      "anyOf": [
        {
          "type": "string"
        },
        {
          "type": "null"
        }
      ],
      "title": "Cancel Requested At"
    },
    "created_at": {
      "title": "Created At",
      "type": "string"
    },
    "error_code": {
      "anyOf": [
        {
          "type": "string"
        },
        {
          "type": "null"
        }
      ],
      "title": "Error Code"
    },
    "error_detail": {
      "anyOf": [
        {
          "maxLength": 256,
          "type": "string"
        },
        {
          "type": "null"
        }
      ],
      "title": "Error Detail"
    },
    "finished_at": {
      "anyOf": [
        {
          "type": "string"
        },
        {
          "type": "null"
        }
      ],
      "title": "Finished At"
    },
    "kind": {
      "enum": [
        "catalog_check",
        "cache_update",
        "cache_rollback",
        "cache_reconcile"
      ],
      "title": "Kind",
      "type": "string"
    },
    "last_activity_at": {
      "anyOf": [
        {
          "type": "string"
        },
        {
          "type": "null"
        }
      ],
      "title": "Last Activity At"
    },
    "max_attempts": {
      "maximum": 3,
      "minimum": 1,
      "title": "Max Attempts",
      "type": "integer"
    },
    "operation_id": {
      "format": "uuid",
      "title": "Operation Id",
      "type": "string"
    },
    "preparation_budget": {
      "anyOf": [
        {
          "$ref": "#/components/schemas/PreparationBudget"
        },
        {
          "type": "null"
        }
      ]
    },
    "reconciliation_budget": {
      "anyOf": [
        {
          "$ref": "#/components/schemas/RecoveryBudget"
        },
        {
          "type": "null"
        }
      ]
    },
    "reconciliation_intent": {
      "anyOf": [
        {
          "$ref": "#/components/schemas/ReconciliationIntent"
        },
        {
          "type": "null"
        }
      ]
    },
    "reconciliation_target": {
      "anyOf": [
        {
          "$ref": "#/components/schemas/RecoveryTarget"
        },
        {
          "type": "null"
        }
      ]
    },
    "request_digest": {
      "pattern": "^[0-9a-f]{64}$",
      "title": "Request Digest",
      "type": "string"
    },
    "requested_components": {
      "items": {
        "type": "string"
      },
      "maxItems": 32,
      "title": "Requested Components",
      "type": "array"
    },
    "result": {
      "anyOf": [
        {
          "discriminator": {
            "mapping": {
              "cache": "#/components/schemas/CacheOperationResult",
              "catalog": "#/components/schemas/CatalogOperationResult",
              "reconciliation": "#/components/schemas/ReconciliationOperationResult"
            },
            "propertyName": "kind"
          },
          "oneOf": [
            {
              "$ref": "#/components/schemas/CatalogOperationResult"
            },
            {
              "$ref": "#/components/schemas/CacheOperationResult"
            },
            {
              "$ref": "#/components/schemas/ReconciliationOperationResult"
            }
          ]
        },
        {
          "type": "null"
        }
      ],
      "title": "Result"
    },
    "schema_version": {
      "enum": [
        1,
        2,
        3
      ],
      "title": "Schema Version",
      "type": "integer"
    },
    "stage": {
      "title": "Stage",
      "type": "string"
    },
    "started_at": {
      "anyOf": [
        {
          "type": "string"
        },
        {
          "type": "null"
        }
      ],
      "title": "Started At"
    },
    "status": {
      "enum": [
        "queued",
        "running",
        "cancelling",
        "completed",
        "failed",
        "cancelled"
      ],
      "title": "Status",
      "type": "string"
    },
    "updated_at": {
      "title": "Updated At",
      "type": "string"
    },
    "workflow_deadline_exceeded": {
      "default": false,
      "title": "Workflow Deadline Exceeded",
      "type": "boolean"
    }
  },
  "required": [
    "schema_version",
    "operation_id",
    "request_digest",
    "kind",
    "requested_components",
    "status",
    "stage",
    "attempt",
    "max_attempts",
    "created_at",
    "updated_at"
  ],
  "title": "OperationRecord",
  "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"
}
500

Keep the operation identity and collect bounded, reviewed diagnostics. See source-linked error catalog.

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.

4 source error observations
StatusSource detailRecovery
422 ↗request_digest_requiredCorrect the field or semantic validation error. Input values are omitted from control validation errors.
404 ↗operation_missingRefresh the collection and verify the resource identity before retrying.
409 ↗operation_conflictRefresh current revision and identity. A conflicting command must not be blindly repeated.
500 ↗operation_ledger_invalidKeep the operation identity and collect bounded, reviewed diagnostics.

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
{
  "attempt": 1,
  "created_at": "synthetic",
  "kind": "catalog_check",
  "max_attempts": 1,
  "operation_id": "00000000-0000-4000-8000-000000000001",
  "request_digest": "0000000000000000000000000000000000000000000000000000000000000000",
  "requested_components": [],
  "schema_version": 1,
  "stage": "synthetic",
  "status": "queued",
  "updated_at": "synthetic"
}
Download this service's complete OpenAPI

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