vulnerability
El dominio vulnerability tiene 16 acciones. En la superficie meta se alcanzan todas a través de arcane_vulnerability; en la individual, cada una es una herramienta propia; en la dinámica se ejecutan con arcane_execute_action y el ID canónico.
Resumen
Sección titulada «Resumen»| Acción | Título | Tipo |
|---|---|---|
vulnerability.export | Export environment vulnerabilities | lectura |
vulnerability.ignore | Ignore a vulnerability | escritura |
vulnerability.ignore_bulk | Ignore vulnerabilities in bulk | escritura |
vulnerability.ignored | List ignored vulnerabilities | lectura |
vulnerability.image_list | List image vulnerabilities | lectura |
vulnerability.image_options | List vulnerability image options | lectura |
vulnerability.image_scan | Scan image for vulnerabilities | escritura |
vulnerability.image_scan_result | Get vulnerability scan result | lectura |
vulnerability.image_summaries | Get vulnerability scan summaries | lectura |
vulnerability.image_summary | Get vulnerability scan summary | lectura |
vulnerability.list | List environment vulnerabilities | lectura |
vulnerability.overview | Get environment vulnerability risk overview | lectura |
vulnerability.scanner_status | Get vulnerability scanner status | lectura |
vulnerability.summary | Get environment vulnerability summary | lectura |
vulnerability.unignore | Unignore a vulnerability | destructiva |
vulnerability.unignore_bulk | Restore ignored vulnerabilities in bulk | escritura |
Acciones
Sección titulada «Acciones»vulnerability.export
Sección titulada «vulnerability.export»Export environment vulnerabilities
Downloads every vulnerability matching the given filters as a CSV file
- Tipo: lectura
- Parámetros obligatorios: ninguno
- Meta-herramienta:
arcane_vulnerabilitycon"action": "export" - Herramienta individual:
arcane_vulnerability_export - Ruta de Arcane:
GET /api/environments/{id}/vulnerabilities/export - ID de operación:
export-environment-vulnerabilities - Desde: Arcane v2.12.0
- Uso: Returns every matching finding at once as CSV text (content plus a .csv filename), with the same filters and sort as vulnerability.list but no paging. ignored=true exports the ignored findings instead of the active ones. A very large export is cut at arcane-mcp’s download limit (truncated=true in the result).
- Acciones relacionadas:
vulnerability.list,vulnerability.image_options
vulnerability.ignore
Sección titulada «vulnerability.ignore»Ignore a vulnerability
Creates an ignore record for a specific vulnerability
- Tipo: escritura
- Parámetros obligatorios:
imageId,pkgName,vulnerabilityId - Meta-herramienta:
arcane_vulnerabilitycon"action": "ignore" - Herramienta individual:
arcane_vulnerability_ignore - Ruta de Arcane:
POST /api/environments/{id}/vulnerabilities/ignore - ID de operación:
ignore-vulnerability - Uso: Hides one finding of one image from the active views and the risk score. Copy imageId, vulnerabilityId, pkgName and installedVersion from a finding of vulnerability.image_scan_result or vulnerability.list: the four together must match the finding exactly, so omit installedVersion only when the finding has none. Arcane does not check that the finding exists, so a mistyped record is still created and hides nothing. reason is optional, and createdBy is set by Arcane from the caller. 409 if already ignored. The returned id is the ignoreId for vulnerability.unignore. Needs vulnerabilities:manage.
- Acciones relacionadas:
vulnerability.image_scan_result,vulnerability.list,vulnerability.ignored,vulnerability.unignore,vulnerability.ignore_bulk
vulnerability.ignore_bulk
Sección titulada «vulnerability.ignore_bulk»Ignore vulnerabilities in bulk
Creates ignore records for every active vulnerability matching the given filters
- Tipo: escritura
- Parámetros obligatorios: ninguno
- Meta-herramienta:
arcane_vulnerabilitycon"action": "ignore_bulk" - Herramienta individual:
arcane_vulnerability_ignore_bulk - Ruta de Arcane:
POST /api/environments/{id}/vulnerabilities/ignore/bulk - ID de operación:
bulk-ignore-vulnerabilities - Desde: Arcane v2.14.0
- Uso: Ignores every active finding matching the filters (severity, imageName, fixAvailable, search: the same matching as vulnerability.list), without a reason. With no filter it ignores every active finding of the environment. Preview the set with vulnerability.list first. Returns affectedCount. Undo with vulnerability.unignore_bulk and the same filters, which also restores matching findings that were ignored before. Needs vulnerabilities:manage.
- Acciones relacionadas:
vulnerability.list,vulnerability.unignore_bulk,vulnerability.ignore,vulnerability.ignored
vulnerability.ignored
Sección titulada «vulnerability.ignored»List ignored vulnerabilities
Retrieves a list of all ignored vulnerabilities for the environment
- Tipo: lectura
- Parámetros obligatorios: ninguno
- Meta-herramienta:
arcane_vulnerabilitycon"action": "ignored" - Herramienta individual:
arcane_vulnerability_ignored - Ruta de Arcane:
GET /api/environments/{id}/vulnerabilities/ignored - ID de operación:
list-ignored-vulnerabilities - Uso: Lists the environment’s ignore records (id, imageId, vulnerabilityId, pkgName, installedVersion, reason, createdBy, createdAt), newest first by default. id is the ignoreId for vulnerability.unignore. search matches vulnerabilityId, pkgName, installedVersion, imageId or reason. sort accepts createdAt or vulnerabilityId with order asc or desc (a - prefix also sorts descending, and any other sort field falls back to newest first), and start and limit page. vulnerability.list with ignored=true lists the ignored findings themselves.
- Acciones relacionadas:
vulnerability.unignore,vulnerability.unignore_bulk,vulnerability.list
vulnerability.image_list
Sección titulada «vulnerability.image_list»List image vulnerabilities
Retrieves paginated vulnerabilities for an image
- Tipo: lectura
- Parámetros obligatorios:
imageId - Meta-herramienta:
arcane_vulnerabilitycon"action": "image_list" - Herramienta individual:
arcane_vulnerability_image_list - Ruta de Arcane:
GET /api/environments/{id}/images/{imageId}/vulnerabilities/list - ID de operación:
list-image-vulnerabilities - Uso: Pages through one scanned image’s findings with search (CVE ID, package, versions, title), severity (e.g. CRITICAL), sort (vulnerabilityId, pkgName, severity, installedVersion, fixedVersion) with order asc/desc, and start/limit (limit defaults to 20). Unlike vulnerability.image_scan_result it does not hide ignored findings. 404 when the image has no scan. Use vulnerability.list to search across all images.
- Acciones relacionadas:
vulnerability.image_scan_result,vulnerability.list,vulnerability.ignore
vulnerability.image_options
Sección titulada «vulnerability.image_options»List vulnerability image options
Retrieves available image filter options for environment vulnerabilities
- Tipo: lectura
- Parámetros obligatorios: ninguno
- Meta-herramienta:
arcane_vulnerabilitycon"action": "image_options" - Herramienta individual:
arcane_vulnerability_image_options - Ruta de Arcane:
GET /api/environments/{id}/vulnerabilities/image-options - ID de operación:
list-environment-vulnerability-image-options - Uso: Lists the image names (or image IDs for unnamed images) that have at least one finding in a completed scan, the valid values for the imageName filter of vulnerability.list, vulnerability.export and the bulk ignore actions. severity (comma-separated) narrows it to images with findings of those severities.
- Acciones relacionadas:
vulnerability.list,vulnerability.export,vulnerability.ignore_bulk
vulnerability.image_scan
Sección titulada «vulnerability.image_scan»Scan image for vulnerabilities
Initiates a vulnerability scan for the specified image using Trivy
- Tipo: escritura
- Parámetros obligatorios:
imageId - Meta-herramienta:
arcane_vulnerabilitycon"action": "image_scan" - Herramienta individual:
arcane_vulnerability_image_scan - Ruta de Arcane:
POST /api/environments/{id}/images/{imageId}/vulnerabilities/scan - ID de operación:
scan-image-vulnerabilities - Uso: Starts a Trivy scan in the background and returns at once with status pending or scanning and an activityId. Poll vulnerability.image_scan_result until status is completed or failed. Pass the image’s sha256 ID (id from image.get or image.list): the scan is stored under the exact string given, and the environment-wide views (vulnerability.list, vulnerability.summary, vulnerability.overview) only match scans stored under the image ID. Needs the vulnerabilities:scan permission.
- Acciones relacionadas:
image.get,vulnerability.image_scan_result,vulnerability.scanner_status,activity.get
vulnerability.image_scan_result
Sección titulada «vulnerability.image_scan_result»Get vulnerability scan result
Retrieves the most recent vulnerability scan result for an image
- Tipo: lectura
- Parámetros obligatorios:
imageId - Meta-herramienta:
arcane_vulnerabilitycon"action": "image_scan_result" - Herramienta individual:
arcane_vulnerability_image_scan_result - Ruta de Arcane:
GET /api/environments/{id}/images/{imageId}/vulnerabilities - ID de operación:
get-image-vulnerabilities - Uso: Use to poll a scan started by vulnerability.image_scan (status pending, scanning, completed or failed, with error on failure) and to read one image’s full findings plus risk insights. imageId is the same string the scan was started with. Ignored findings are left out of vulnerabilities, and 404 means the image was never scanned. Each finding’s vulnerabilityId, pkgName and installedVersion are the inputs of vulnerability.ignore.
- Acciones relacionadas:
vulnerability.image_scan,vulnerability.image_list,vulnerability.image_summary,vulnerability.ignore
vulnerability.image_summaries
Sección titulada «vulnerability.image_summaries»Get vulnerability scan summaries
Retrieves scan summaries for a list of images (batch)
- Tipo: lectura
- Parámetros obligatorios:
imageIds - Meta-herramienta:
arcane_vulnerabilitycon"action": "image_summaries" - Herramienta individual:
arcane_vulnerability_image_summaries - Ruta de Arcane:
POST /api/environments/{id}/images/vulnerabilities/summaries - ID de operación:
get-image-vulnerability-summaries - Uso: Batch form of vulnerability.image_summary: pass imageIds (image IDs from image.list) and get summaries, a map keyed by image ID. Images never scanned are simply absent from the map.
- Acciones relacionadas:
image.list,vulnerability.image_summary,vulnerability.image_scan
vulnerability.image_summary
Sección titulada «vulnerability.image_summary»Get vulnerability scan summary
Retrieves just the summary of vulnerabilities for an image (for list views)
- Tipo: lectura
- Parámetros obligatorios:
imageId - Meta-herramienta:
arcane_vulnerabilitycon"action": "image_summary" - Herramienta individual:
arcane_vulnerability_image_summary - Ruta de Arcane:
GET /api/environments/{id}/images/{imageId}/vulnerabilities/summary - ID de operación:
get-image-vulnerability-summary - Uso: Use for just one image’s scan status and per-severity counts (summary.critical/high/medium/low/unknown/total) without the findings, with imageId as given to vulnerability.image_scan. The counts are those recorded at scan time, so they still include ignored findings. 404 when the image has no scan.
- Acciones relacionadas:
vulnerability.image_scan_result,vulnerability.image_summaries,vulnerability.image_scan
vulnerability.list
Sección titulada «vulnerability.list»List environment vulnerabilities
Retrieves paginated vulnerabilities across all scanned images in the environment
- Tipo: lectura
- Parámetros obligatorios: ninguno
- Meta-herramienta:
arcane_vulnerabilitycon"action": "list" - Herramienta individual:
arcane_vulnerability_list - Ruta de Arcane:
GET /api/environments/{id}/vulnerabilities/all - ID de operación:
list-environment-vulnerabilities - Uso: Pages through the findings of every completed scan of images still present in the environment, each row with imageId and imageName. Filters: severity (comma-separated, e.g. CRITICAL,HIGH), imageName (case-insensitive substring, comma-separated alternatives, values from vulnerability.image_options), fixAvailable=true, search (CVE ID, package, versions, title, image name or ID). ignored=true lists ignored findings instead of active ones, each with its ignoreId for vulnerability.unignore. Sort by vulnerabilityId, pkgName, severity, installedVersion, fixedVersion or imageName. limit defaults to 20.
- Acciones relacionadas:
vulnerability.image_options,vulnerability.export,vulnerability.ignore,vulnerability.ignore_bulk,vulnerability.unignore
vulnerability.overview
Sección titulada «vulnerability.overview»Get environment vulnerability risk overview
Retrieves the environment risk score, trend, drivers, riskiest images and priority findings
- Tipo: lectura
- Parámetros obligatorios: ninguno
- Meta-herramienta:
arcane_vulnerabilitycon"action": "overview" - Herramienta individual:
arcane_vulnerability_overview - Ruta de Arcane:
GET /api/environments/{id}/vulnerabilities/overview - ID de operación:
get-environment-vulnerability-overview - Desde: Arcane v2.14.0
- Uso: Use to decide what to fix first: riskScore and riskBand with a 7-day delta and trend, the drivers behind the score (findings, fixable, knownExploited, highEpss, imagesScanned…), exposure (findings counted by whether their image is used by running containers, only by stopped ones, or by none), riskiestImages, riskiestFindings and prevalentFindings. Ignored findings are not scored.
- Acciones relacionadas:
vulnerability.summary,vulnerability.list,vulnerability.image_scan_result,image.patch_targets
vulnerability.scanner_status
Sección titulada «vulnerability.scanner_status»Get vulnerability scanner status
Check if the vulnerability scanner (Trivy) is available and get its version
- Tipo: lectura
- Parámetros obligatorios: ninguno
- Meta-herramienta:
arcane_vulnerabilitycon"action": "scanner_status" - Herramienta individual:
arcane_vulnerability_scanner_status - Ruta de Arcane:
GET /api/environments/{id}/vulnerabilities/scanner-status - ID de operación:
get-vulnerability-scanner-status - Uso: Check before a first scan: available is false (with an empty version) when Arcane cannot run Trivy. It may pull Arcane’s tools image and start a short-lived container to read the version. Every vulnerability action answers 403 when the vulnerability management feature (setting featureVulnerabilityManagementEnabled, on by default) is off.
- Acciones relacionadas:
vulnerability.image_scan,settings.get,settings.update
vulnerability.summary
Sección titulada «vulnerability.summary»Get environment vulnerability summary
Retrieves aggregated vulnerability counts across all images in the environment
- Tipo: lectura
- Parámetros obligatorios: ninguno
- Meta-herramienta:
arcane_vulnerabilitycon"action": "summary" - Herramienta individual:
arcane_vulnerability_summary - Ruta de Arcane:
GET /api/environments/{id}/vulnerabilities/summary - ID de operación:
get-environment-vulnerability-summary - Uso: Quick environment totals: totalImages on the daemon, scannedImages with a completed scan, and summary with per-severity finding counts summed over those scans, ignored findings included. Use vulnerability.overview for the risk score and priorities, vulnerability.list for the findings themselves.
- Acciones relacionadas:
vulnerability.overview,vulnerability.list,vulnerability.image_summaries
vulnerability.unignore
Sección titulada «vulnerability.unignore»Unignore a vulnerability
Removes an ignore record for a vulnerability
- Tipo: destructiva — exige
confirm: true - Parámetros obligatorios:
ignoreId - Meta-herramienta:
arcane_vulnerabilitycon"action": "unignore" - Herramienta individual:
arcane_vulnerability_unignore - Ruta de Arcane:
DELETE /api/environments/{id}/vulnerabilities/ignore/{ignoreId} - ID de operación:
unignore-vulnerability - Uso: Deletes one ignore record so its finding is active again, together with any duplicate record for the same finding. ignoreId comes from vulnerability.ignored, from the id returned by vulnerability.ignore, or from ignoreId in vulnerability.list with ignored=true. 404 if the record does not exist. Needs vulnerabilities:manage.
- Acciones relacionadas:
vulnerability.ignored,vulnerability.list,vulnerability.unignore_bulk
vulnerability.unignore_bulk
Sección titulada «vulnerability.unignore_bulk»Restore ignored vulnerabilities in bulk
Removes every ignore record matching the given filters
- Tipo: escritura
- Parámetros obligatorios: ninguno
- Meta-herramienta:
arcane_vulnerabilitycon"action": "unignore_bulk" - Herramienta individual:
arcane_vulnerability_unignore_bulk - Ruta de Arcane:
POST /api/environments/{id}/vulnerabilities/unignore/bulk - ID de operación:
bulk-unignore-vulnerabilities - Desde: Arcane v2.14.0
- Uso: Deletes every ignore record whose finding matches the filters (severity, imageName, fixAvailable, search: the same matching as vulnerability.list with ignored=true). With no filter it restores every ignored finding of a completed scan of an image still present, while records for removed or unscanned images stay (delete those with vulnerability.unignore). Returns affectedCount. Needs vulnerabilities:manage.
- Acciones relacionadas:
vulnerability.list,vulnerability.ignore_bulk,vulnerability.ignored,vulnerability.unignore