Skip to main content

Custom Ingest step for SARIF and JSON scan results

The Custom Ingest step enables you to ingest results from any third-party scanner. Harness STO supports two generic data formats:

  • SARIF is an open data format supported by many scan tools, especially tools available as GitHub Actions. You can easily ingest SARIF 2.1.0 data from any tool that supports this format. If your scanner can export to SARIF, use this format. For more information, go to Ingest SARIF results.

  • Harness STO supports a custom JSON format that's useful for ingesting data from scanners that currently have no integration in STO and that cannot publish to SARIF. For more information, go to Ingest Results from Unsupported Scanners.


The Custom Ingest step is intended for scanners that have no supported integration in STO. Harness recommends that you always use the documented workflow for supported scanners. For a list of all STO-supported scanners, go to Security Step Settings Reference.

For more information

The following topics contain useful information for setting up scanner integrations in STO:

Custom Ingest step settings for STO scans


Scan mode

Scan Configuration

The predefined configuration to use for the scan. All scan steps have at least one configuration.



The target type of the scanned object. You can ingest data for the following target types:

  • Repository Ingest scan results for a code repo.
  • Container image Ingest scan results for the layers, libraries, and packages in a container image.
  • Instance Ingest scan results for a running application.
  • Configuration Ingest scan results for your cloud environment, generated by gathering configuration data via the cloud provider's APIs.


The identifier for the target, such as codebaseAlpha or jsmith/myalphaservice. Descriptive target names make it much easier to navigate your scan data in the STO UI.

It is good practice to specify a baseline for every target.


The identifier for the specific variant to scan. This is usually the branch name, image tag, or product version. Harness maintains a historical trend for each variant.


Ingestion File

The path to your scan results when running an Ingestion scan, for example /shared/scan_results/myscan.latest.sarif.

  • The data file must be in a supported format for the scanner.

  • The data file must be accessible to the scan step. It's good practice to save your results files to a shared path in your stage. In the visual editor, go to the stage where you're running the scan. Then go to Overview > Shared Paths. You can also add the path to the YAML stage definition like this:

        - stage:
    - /shared/scan_results

Log Level, CLI flags, and Fail on Severity

Log Level

The minimum severity of the messages you want to include in your scan logs. You can specify one of the following:

  • INFO

Additional CLI flags

Use this field to run the scanner binary with additional flags supported by the external scanner.

Fail on Severity

Every STO scan step has a Fail on Severity setting. If the scan finds any vulnerability with the specified severity level or higher, the pipeline fails automatically. You can specify one of the following:

  • HIGH
  • LOW
  • INFO
  • NONE — Do not fail on severity

The YAML definition looks like this: fail_on_severity : critical # | high | medium | low | info | none

Additional Configuration

In the Additional Configuration settings, you can use the following options:

Advanced settings

In the Advanced settings, you can use the following options:

Custom Ingest pipeline examples

Here are some topics that describe end-to-end workflows for ingesting SARIF and JSON data: