POST /v1/scanner/cache/update

Update scanner cache. Permissions, parameters, responses and examples.

0.1.0 · source bccff29 · Immutable snapshot · Download OpenAPI specification

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

Update scanner cache

Update scanner cache through POST /v1/scanner/cache/update. 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 only at the middleware boundary. Route-specific ownership and generation checks also apply.

Browser mutations require the exact control Origin and session-bound CSRF header. IDE callers use only their admitted route scope and exact generation.

Inspect the authority source · Authentication guide

Parameters and headers

Name	Location	Contract
`X-CSRF-Token`	header Conditional / optional	Required for browser mutations with the exact control Origin. Not an IDE capability. Schema `{ "type": "string" }`
`Idempotency-Key`	header Required	Required for command submission; for bulk findings, only the triage action. Stable key for the same exact command, beginning with a letter or digit. Reuse with different content conflicts. Schema `{ "maxLength": 160, "minLength": 8, "pattern": "^[A-Za-z0-9][A-Za-z0-9._:-]{7,159}$", "type": "string" }`

Request body

JSON body · required · ScannerCacheUpdateRequest

Field	Type	Presence
`catalog_digest`	string \| null	Optional
`component_ids`	array	Required

Complete declared request schema

{
  "additionalProperties": false,
  "properties": {
    "catalog_digest": {
      "anyOf": [
        {
          "pattern": "^[0-9a-f]{64}$",
          "type": "string"
        },
        {
          "type": "null"
        }
      ],
      "title": "Catalog Digest"
    },
    "component_ids": {
      "items": {
        "enum": [
          "trivy-db",
          "trivy-java-db",
          "trivy-checks",
          "opengrep-reviewed-rules",
          "bearer-rules",
          "grype-db"
        ],
        "type": "string"
      },
      "maxItems": 6,
      "minItems": 1,
      "title": "Component Ids",
      "type": "array"
    }
  },
  "required": [
    "component_ids"
  ],
  "title": "ScannerCacheUpdateRequest",
  "type": "object"
}

Responses

Status	Meaning and declared shape
`202`	Successful Response application/json · ScannerLifecycleCommandOut `{ "properties": { "job": { "$ref": "#/components/schemas/JobOut" }, "lifecycle": { "$ref": "#/components/schemas/ScannerLifecycleScopeOut" } }, "required": [ "job", "lifecycle" ], "title": "ScannerLifecycleCommandOut", "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" }`
`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" }`
`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.

15 source error observations

Status	Source detail	Recovery
409 ↗	`no previous-good scanner cache generation is available`	Refresh current revision and identity. A conflicting command must not be blindly repeated.
409 ↗	`Dynamic detail; inspect source`	Refresh current revision and identity. A conflicting command must not be blindly repeated.
409 ↗	`Dynamic detail; inspect source`	Refresh current revision and identity. A conflicting command must not be blindly repeated.
409 ↗	`Dynamic detail; inspect source`	Refresh current revision and identity. A conflicting command must not be blindly repeated.
409 ↗	`Dynamic detail; inspect source`	Refresh current revision and identity. A conflicting command must not be blindly repeated.
409 ↗	`Dynamic detail; inspect source`	Refresh current revision and identity. A conflicting command must not be blindly repeated.
409 ↗	`Idempotency-Key is already bound to a different command`	Refresh current revision and identity. A conflicting command must not be blindly repeated.
409 ↗	`Dynamic detail; inspect source`	Refresh current revision and identity. A conflicting command must not be blindly repeated.
422 ↗	`Dynamic detail; inspect source`	Correct the field or semantic validation error. Input values are omitted from control validation errors.
409 ↗	`Dynamic detail; inspect source`	Refresh current revision and identity. A conflicting command must not be blindly repeated.
401 ↗	`authentication required`	Reconcile the exact browser or IDE membership through the normal owner workflow.
422 ↗	`Idempotency-Key must contain 8-160 ASCII letters, digits, '.', '_', ':', or '-'`	Correct the field or semantic validation error. Input values are omitted from control validation errors.
409 ↗	`Dynamic detail; inspect source`	Refresh current revision and identity. A conflicting command must not be blindly repeated.
409 ↗	`Dynamic detail; inspect source`	Refresh current revision and identity. A conflicting command must not be blindly repeated.
409 ↗	`Dynamic detail; inspect source`	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.

Request JSON

{
  "component_ids": [
    "trivy-db"
  ]
}

Response 202 JSON

{
  "job": {
    "completed_at": "2026-01-01T00:00:00Z",
    "created_at": "2026-01-01T00:00:00Z",
    "detail": "synthetic",
    "error": "synthetic",
    "finding_id": 1,
    "id": 1,
    "kind": "synthetic",
    "progress": 1,
    "scan_id": 1,
    "stage": "synthetic",
    "started_at": "2026-01-01T00:00:00Z",
    "status": "synthetic",
    "title": "synthetic",
    "updated_at": "2026-01-01T00:00:00Z"
  },
  "lifecycle": {
    "active_generation": "synthetic",
    "completed_at": "2026-01-01T00:00:00Z",
    "error_code": "synthetic",
    "error_detail": "synthetic",
    "job_id": 1,
    "job_url": "synthetic",
    "previous_generation": "synthetic",
    "receipt": {},
    "revision": 1,
    "scope": "catalog",
    "started_at": "2026-01-01T00:00:00Z",
    "status": "idle",
    "updated_at": "2026-01-01T00:00:00Z"
  }
}

Download this service's complete OpenAPI

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