Skip to main content

Interface: SyncScanOptions

Defined in: src/scan/scanner.ts:55

Optional parameters for Scanner.syncScan.

Extends​

Properties​

numRetries?​

optional numRetries?: number;

Defined in: src/scan/scanner.ts:51

Per-call retry override (0–5). Omit to use the global configuration.

Inherited from​

ScanCallOptions.numRetries

trId?​

optional trId?: string;

Defined in: src/scan/scanner.ts:57

Transaction ID for tracing. Max 100 characters.

sessionId?​

optional sessionId?: string;

Defined in: src/scan/scanner.ts:59

Session ID for grouping related scans. Max 100 characters.

metadata?​

optional metadata?: objectOutputType<{
  app_name: ZodOptional<ZodString>;
  app_user: ZodOptional<ZodString>;
  ai_model: ZodOptional<ZodString>;
  user_ip: ZodOptional<ZodString>;
  agent_meta: ZodOptional<ZodObject<{
     agent_id: ZodOptional<ZodString>;
     agent_version: ZodOptional<ZodString>;
     agent_arn: ZodOptional<ZodString>;
   }, "passthrough", ZodTypeAny, objectOutputType<{
     agent_id: ZodOptional<ZodString>;
     agent_version: ZodOptional<ZodString>;
     agent_arn: ZodOptional<ZodString>;
   }, ZodTypeAny, "passthrough">, objectInputType<{
     agent_id: ZodOptional<ZodString>;
     agent_version: ZodOptional<ZodString>;
     agent_arn: ZodOptional<ZodString>;
  }, ZodTypeAny, "passthrough">>>;
}, ZodTypeAny, "passthrough">;

Defined in: src/scan/scanner.ts:61

Application metadata attached to the scan request.