Trigger SecObserve Built-In Scan
secobserve_trigger_scanTrigger a built-in OSV or VulnerableCode scan on product components to generate vulnerability findings. Specify scanner and product ID; optional branch limits to one. Use after SBOM import to get observations.
Instructions
Run SecObserve's own OSV or VulnerableCode scan over a product's known components.
These scanners need no report: they look up the components SecObserve already has, which is why they are the usual follow-up to an SBOM import. Each must be enabled on the product (osv_enabled / vulnerablecode_enabled) or the call is rejected. The request blocks until the scan finishes, so a product with many components can exceed the HTTP timeout.
Args: params (TriggerScanInput): Validated input containing: - scanner (str): "osv" or "vulnerablecode". - product_id (int): Product to scan. - branch_id (Optional[int]): One branch, or every branch when omitted.
Returns: str: observations_new, observations_updated and observations_resolved for the scan, one per line.
Examples: - Use when: "re-check product 12 against osv.dev" -> scanner="osv", product_id=12 - Use when: right after importing an SBOM, to get findings for its components. - Don't use when: the product has no components yet (import an SBOM first).
Error Handling: 400 "OSV scan is not enabled for product X" means enable it on the product first (secobserve_update, data={"osv_enabled": true}). A timeout does not cancel the scan -- check secobserve_list(resource="vulnerability_checks") rather than retrying blind.
Input Schema
| Name | Required | Description | Default |
|---|---|---|---|
| params | Yes |
Output Schema
| Name | Required | Description | Default |
|---|---|---|---|
| result | Yes |