Agent Armor API Reference
    Preparing search index...

    Interface ScanOptions

    Options accepted by every scan method (scanSync, scan, scanRAGChunks(Sync), scanOutput(Sync), scanSession(Async)) as an optional second/last parameter.

    interface ScanOptions {
        exception?: { actor: string; reason: string };
        includeEvidence?: boolean;
    }
    Index
    exception? includeEvidence?
    exception?: { actor: string; reason: string }

    Marks this scan as a known, intentional override — you've already decided to let this content through despite risk, and want that decision captured on the audit record instead of the auto-derived allow/sanitize/block.

    includeEvidence?: boolean

    Include the raw offending snippet (not just its hash) on the audit record. Opt-in only — carries the data-handling responsibility of storing content in your audit sink. Default: false.

    Settings
    Member Visibility

    On This Page
    Properties