> For the complete documentation index, see [llms.txt](https://developer.harness.io/llms.txt). Markdown versions of documentation pages are available by appending `.md` to page URLs; this page is available as [Markdown](https://developer.harness.io/api-reference/security-testing-agent-apis/security-testing-orchestration/scanner-settings.md).

# Scanner Settings

Scanner settings stored per Harness scope, merged for scan-time consumers (Qwiet CLI)

## Update scanner settings at scope

> Apply sparse settings changes at the viewed Harness scope. Each top-level block in the body contains only changed fields; the server deep-merges them into the resolved block and stores a full block snapshot for each named block. Other top-level blocks already stored on the scope row are left unchanged.

```json
{"openapi":"3.0.3","info":{"title":"Harness Security Test Orchestration API","version":"1.0.0"},"tags":[{"name":"ScannerSettings","description":"Scanner settings stored per Harness scope, merged for scan-time consumers (Qwiet CLI)"}],"servers":[{"url":"https://app.harness.io/gateway/sto"},{"url":"http://127.0.0.1:4000"}],"security":[{"X-Api-Key_header_X-Api-Key":[],"jwt_header_Authorization":["sto_testtarget_edit"]}],"components":{"securitySchemes":{"X-Api-Key_header_X-Api-Key":{"type":"apiKey","name":"X-Api-Key","in":"header"},"jwt_header_Authorization":{"type":"http","scheme":"bearer"}},"schemas":{"PutScannerSettingsBody":{"type":"object","properties":{"settings":{"type":"object","description":"Sparse map of top-level blocks to partial field updates.","additionalProperties":true}},"required":["settings"]},"ResolvedScannerSettings":{"type":"object","properties":{"metadata":{"$ref":"#/components/schemas/ScannerSettingsMetadata"},"overrides":{"type":"object","description":"Raw delta settings stored at the viewed scope. Empty when nothing is set there.","additionalProperties":true},"scope":{"type":"string","description":"Narrowest requested scope: ACCOUNT, ORG, PROJECT or TARGET."},"settings":{"type":"object","description":"Resolved settings merged across the scope chain.","additionalProperties":true},"sources":{"type":"object","description":"Top-level block name -> scope that last set it (DEFAULT, ACCOUNT, ORG, PROJECT or TARGET).","additionalProperties":{"type":"string"}}},"required":["scope","settings","sources","overrides","metadata"]},"ScannerSettingsMetadata":{"type":"object","properties":{"secret_detection_plugins":{"type":"array","items":{"$ref":"#/components/schemas/SecretDetectionPlugin"},"description":"Catalog of detect-secrets plugins. All are enabled unless their value is listed in the client-secrets disable-plugin setting. UI renders the checkbox list from this catalog and writes back only disabled values."},"skills_paths":{"type":"array","items":{"$ref":"#/components/schemas/SkillsPathSetting"},"description":"Effective AI skills directory paths with removable flags. Paths matching the CLI defaults are not removable; user-added paths are."}},"description":"UI affordance metadata for the scanner settings screen. Derived by the backend; not stored in scanner_setting and never sent to the Qwiet CLI.","required":["secret_detection_plugins","skills_paths"]},"SecretDetectionPlugin":{"type":"object","properties":{"label":{"type":"string","description":"Human-readable display name for the UI checkbox list."},"value":{"type":"string","description":"detect-secrets plugin name. This exact value goes into the client-secrets disable-plugin setting consumed by the Qwiet CLI."}},"description":"One detect-secrets plugin with its UI display label.","required":["value","label"]},"SkillsPathSetting":{"type":"object","properties":{"removable":{"type":"boolean","description":"False for Qwiet CLI default paths (they cannot be removed, only reordered after); true for user-added paths."},"value":{"type":"string","description":"The skills directory path, relative to the repository root."}},"description":"One AI skills directory path with UI affordance metadata.","required":["value","removable"]},"NotFound":{"type":"object","properties":{"message":{"type":"string"},"status":{"type":"integer","default":404,"format":"int64"}},"required":["message"]}}},"paths":{"/api/v2/scanner-settings":{"put":{"tags":["ScannerSettings"],"summary":"Update scanner settings at scope","description":"Apply sparse settings changes at the viewed Harness scope. Each top-level block in the body contains only changed fields; the server deep-merges them into the resolved block and stores a full block snapshot for each named block. Other top-level blocks already stored on the scope row are left unchanged.","operationId":"ScannerSettings#PutScannerSettings","parameters":[{"name":"accountId","in":"query","description":"Harness Account ID","allowEmptyValue":true,"required":true,"schema":{"type":"string","description":"Harness Account ID","pattern":"^[a-zA-Z0-9_-]{22}$"}},{"name":"orgId","in":"query","description":"Harness Organization ID","allowEmptyValue":true,"schema":{"type":"string","description":"Harness Organization ID","pattern":"^[A-Za-z_][A-Za-z0-9_]*$","maxLength":128}},{"name":"projectId","in":"query","description":"Harness Project ID","allowEmptyValue":true,"schema":{"type":"string","description":"Harness Project ID","pattern":"^[A-Za-z_][A-Za-z0-9_]*$","maxLength":128}},{"name":"productName","in":"query","description":"Seeded product.name whose id keys scanner_setting rows.","allowEmptyValue":true,"required":true,"schema":{"type":"string","description":"Seeded product.name whose id keys scanner_setting rows.","minLength":1,"maxLength":128}},{"name":"targetId","in":"query","description":"Optional Harness target ID. When set, the target scope is the viewed scope.","allowEmptyValue":true,"schema":{"type":"string","description":"Optional Harness target ID. When set, the target scope is the viewed scope.","pattern":"^[a-zA-Z0-9_-]{22}$"}},{"name":"X-Api-Key","in":"header","description":"Harness personal or service access token","allowEmptyValue":true,"schema":{"type":"string","description":"Harness personal or service access token"}}],"requestBody":{"required":true,"content":{"application/json":{"schema":{"$ref":"#/components/schemas/PutScannerSettingsBody"}}}},"responses":{"200":{"description":"OK response.","content":{"application/json":{"schema":{"$ref":"#/components/schemas/ResolvedScannerSettings"}}}},"400":{"description":"BadRequest: Bad Request response.","content":{"application/json":{"schema":{"$ref":"#/components/schemas/NotFound"}}}},"401":{"description":"Unauthorized: Unauthorized response.","content":{"application/json":{"schema":{"$ref":"#/components/schemas/NotFound"}}}},"403":{"description":"Forbidden: Forbidden response.","content":{"application/json":{"schema":{"$ref":"#/components/schemas/NotFound"}}}},"404":{"description":"NotFound: Not Found response.","content":{"application/json":{"schema":{"$ref":"#/components/schemas/NotFound"}}}},"429":{"description":"TooManyRequests: Too Many Requests response.","content":{"application/json":{"schema":{"$ref":"#/components/schemas/NotFound"}}}},"500":{"description":"InternalServerError: Internal Server Error response.","content":{"application/json":{"schema":{"$ref":"#/components/schemas/NotFound"}}}}}}}}}
```

## Get merged scanner settings

> Scanner settings merged across Harness scopes. Rows come from scanner\_setting for the product named by productName. Merge order is DEFAULT, account, org, project, target. For each top-level block, the narrowest scope that stored that block wins the whole block; nested keys from broader scopes do not leak in. Blocks absent at every scope are omitted so the caller applies its own defaults. targetId requires orgId and projectId.

```json
{"openapi":"3.0.3","info":{"title":"Harness Security Test Orchestration API","version":"1.0.0"},"tags":[{"name":"ScannerSettings","description":"Scanner settings stored per Harness scope, merged for scan-time consumers (Qwiet CLI)"}],"servers":[{"url":"https://app.harness.io/gateway/sto"},{"url":"http://127.0.0.1:4000"}],"security":[{"X-Api-Key_header_X-Api-Key":[],"jwt_header_Authorization":["sto_testtarget_view"]}],"components":{"securitySchemes":{"X-Api-Key_header_X-Api-Key":{"type":"apiKey","name":"X-Api-Key","in":"header"},"jwt_header_Authorization":{"type":"http","scheme":"bearer"}},"schemas":{"NotFound":{"type":"object","properties":{"message":{"type":"string"},"status":{"type":"integer","default":404,"format":"int64"}},"required":["message"]}}},"paths":{"/api/v2/scanner-settings/merged":{"get":{"tags":["ScannerSettings"],"summary":"Get merged scanner settings","description":"Scanner settings merged across Harness scopes. Rows come from scanner_setting for the product named by productName. Merge order is DEFAULT, account, org, project, target. For each top-level block, the narrowest scope that stored that block wins the whole block; nested keys from broader scopes do not leak in. Blocks absent at every scope are omitted so the caller applies its own defaults. targetId requires orgId and projectId.","operationId":"ScannerSettings#GetMergedScannerSettings","parameters":[{"name":"accountId","in":"query","description":"Harness Account ID","allowEmptyValue":true,"required":true,"schema":{"type":"string","description":"Harness Account ID","pattern":"^[a-zA-Z0-9_-]{22}$"}},{"name":"orgId","in":"query","description":"Harness Organization ID","allowEmptyValue":true,"schema":{"type":"string","description":"Harness Organization ID","pattern":"^[A-Za-z_][A-Za-z0-9_]*$","maxLength":128}},{"name":"projectId","in":"query","description":"Harness Project ID","allowEmptyValue":true,"schema":{"type":"string","description":"Harness Project ID","pattern":"^[A-Za-z_][A-Za-z0-9_]*$","maxLength":128}},{"name":"productName","in":"query","description":"Seeded product.name whose id keys scanner_setting rows.","allowEmptyValue":true,"required":true,"schema":{"type":"string","description":"Seeded product.name whose id keys scanner_setting rows.","minLength":1,"maxLength":128}},{"name":"targetId","in":"query","description":"Optional Harness target ID. When set, target-scoped settings are included and win over broader scopes.","allowEmptyValue":true,"schema":{"type":"string","description":"Optional Harness target ID. When set, target-scoped settings are included and win over broader scopes.","pattern":"^[a-zA-Z0-9_-]{22}$"}},{"name":"X-Api-Key","in":"header","description":"Harness personal or service access token","allowEmptyValue":true,"schema":{"type":"string","description":"Harness personal or service access token"}}],"responses":{"200":{"description":"OK response.","content":{"application/json":{"schema":{"type":"object","additionalProperties":true}}}},"400":{"description":"BadRequest: Bad Request response.","content":{"application/json":{"schema":{"$ref":"#/components/schemas/NotFound"}}}},"401":{"description":"Unauthorized: Unauthorized response.","content":{"application/json":{"schema":{"$ref":"#/components/schemas/NotFound"}}}},"403":{"description":"Forbidden: Forbidden response.","content":{"application/json":{"schema":{"$ref":"#/components/schemas/NotFound"}}}},"404":{"description":"NotFound: Not Found response.","content":{"application/json":{"schema":{"$ref":"#/components/schemas/NotFound"}}}},"429":{"description":"TooManyRequests: Too Many Requests response.","content":{"application/json":{"schema":{"$ref":"#/components/schemas/NotFound"}}}},"500":{"description":"InternalServerError: Internal Server Error response.","content":{"application/json":{"schema":{"$ref":"#/components/schemas/NotFound"}}}}}}}}}
```

## Get resolved scanner settings with provenance

> Scanner settings resolved across Harness scopes for the settings UI. Returns the merged settings, the scope that last set each top-level block, and the raw delta stored at the requested scope. The UI badges a block Overridden when it appears in overrides, Inherited otherwise.

```json
{"openapi":"3.0.3","info":{"title":"Harness Security Test Orchestration API","version":"1.0.0"},"tags":[{"name":"ScannerSettings","description":"Scanner settings stored per Harness scope, merged for scan-time consumers (Qwiet CLI)"}],"servers":[{"url":"https://app.harness.io/gateway/sto"},{"url":"http://127.0.0.1:4000"}],"security":[{"X-Api-Key_header_X-Api-Key":[],"jwt_header_Authorization":["sto_testtarget_view"]}],"components":{"securitySchemes":{"X-Api-Key_header_X-Api-Key":{"type":"apiKey","name":"X-Api-Key","in":"header"},"jwt_header_Authorization":{"type":"http","scheme":"bearer"}},"schemas":{"ResolvedScannerSettings":{"type":"object","properties":{"metadata":{"$ref":"#/components/schemas/ScannerSettingsMetadata"},"overrides":{"type":"object","description":"Raw delta settings stored at the viewed scope. Empty when nothing is set there.","additionalProperties":true},"scope":{"type":"string","description":"Narrowest requested scope: ACCOUNT, ORG, PROJECT or TARGET."},"settings":{"type":"object","description":"Resolved settings merged across the scope chain.","additionalProperties":true},"sources":{"type":"object","description":"Top-level block name -> scope that last set it (DEFAULT, ACCOUNT, ORG, PROJECT or TARGET).","additionalProperties":{"type":"string"}}},"required":["scope","settings","sources","overrides","metadata"]},"ScannerSettingsMetadata":{"type":"object","properties":{"secret_detection_plugins":{"type":"array","items":{"$ref":"#/components/schemas/SecretDetectionPlugin"},"description":"Catalog of detect-secrets plugins. All are enabled unless their value is listed in the client-secrets disable-plugin setting. UI renders the checkbox list from this catalog and writes back only disabled values."},"skills_paths":{"type":"array","items":{"$ref":"#/components/schemas/SkillsPathSetting"},"description":"Effective AI skills directory paths with removable flags. Paths matching the CLI defaults are not removable; user-added paths are."}},"description":"UI affordance metadata for the scanner settings screen. Derived by the backend; not stored in scanner_setting and never sent to the Qwiet CLI.","required":["secret_detection_plugins","skills_paths"]},"SecretDetectionPlugin":{"type":"object","properties":{"label":{"type":"string","description":"Human-readable display name for the UI checkbox list."},"value":{"type":"string","description":"detect-secrets plugin name. This exact value goes into the client-secrets disable-plugin setting consumed by the Qwiet CLI."}},"description":"One detect-secrets plugin with its UI display label.","required":["value","label"]},"SkillsPathSetting":{"type":"object","properties":{"removable":{"type":"boolean","description":"False for Qwiet CLI default paths (they cannot be removed, only reordered after); true for user-added paths."},"value":{"type":"string","description":"The skills directory path, relative to the repository root."}},"description":"One AI skills directory path with UI affordance metadata.","required":["value","removable"]},"NotFound":{"type":"object","properties":{"message":{"type":"string"},"status":{"type":"integer","default":404,"format":"int64"}},"required":["message"]}}},"paths":{"/api/v2/scanner-settings/resolved":{"get":{"tags":["ScannerSettings"],"summary":"Get resolved scanner settings with provenance","description":"Scanner settings resolved across Harness scopes for the settings UI. Returns the merged settings, the scope that last set each top-level block, and the raw delta stored at the requested scope. The UI badges a block Overridden when it appears in overrides, Inherited otherwise.","operationId":"ScannerSettings#GetResolvedScannerSettings","parameters":[{"name":"accountId","in":"query","description":"Harness Account ID","allowEmptyValue":true,"required":true,"schema":{"type":"string","description":"Harness Account ID","pattern":"^[a-zA-Z0-9_-]{22}$"}},{"name":"orgId","in":"query","description":"Harness Organization ID","allowEmptyValue":true,"schema":{"type":"string","description":"Harness Organization ID","pattern":"^[A-Za-z_][A-Za-z0-9_]*$","maxLength":128}},{"name":"projectId","in":"query","description":"Harness Project ID","allowEmptyValue":true,"schema":{"type":"string","description":"Harness Project ID","pattern":"^[A-Za-z_][A-Za-z0-9_]*$","maxLength":128}},{"name":"productName","in":"query","description":"Seeded product.name whose id keys scanner_setting rows.","allowEmptyValue":true,"required":true,"schema":{"type":"string","description":"Seeded product.name whose id keys scanner_setting rows.","minLength":1,"maxLength":128}},{"name":"targetId","in":"query","description":"Optional Harness target ID. When set, the target scope is the viewed scope.","allowEmptyValue":true,"schema":{"type":"string","description":"Optional Harness target ID. When set, the target scope is the viewed scope.","pattern":"^[a-zA-Z0-9_-]{22}$"}},{"name":"X-Api-Key","in":"header","description":"Harness personal or service access token","allowEmptyValue":true,"schema":{"type":"string","description":"Harness personal or service access token"}}],"responses":{"200":{"description":"OK response.","content":{"application/json":{"schema":{"$ref":"#/components/schemas/ResolvedScannerSettings"}}}},"400":{"description":"BadRequest: Bad Request response.","content":{"application/json":{"schema":{"$ref":"#/components/schemas/NotFound"}}}},"401":{"description":"Unauthorized: Unauthorized response.","content":{"application/json":{"schema":{"$ref":"#/components/schemas/NotFound"}}}},"403":{"description":"Forbidden: Forbidden response.","content":{"application/json":{"schema":{"$ref":"#/components/schemas/NotFound"}}}},"404":{"description":"NotFound: Not Found response.","content":{"application/json":{"schema":{"$ref":"#/components/schemas/NotFound"}}}},"429":{"description":"TooManyRequests: Too Many Requests response.","content":{"application/json":{"schema":{"$ref":"#/components/schemas/NotFound"}}}},"500":{"description":"InternalServerError: Internal Server Error response.","content":{"application/json":{"schema":{"$ref":"#/components/schemas/NotFound"}}}}}}}}}
```

## Restore scanner settings blocks at scope

> Remove top-level settings blocks stored at the viewed Harness scope so effective values inherit from broader scopes. Deletes the scope row when no blocks remain.

```json
{"openapi":"3.0.3","info":{"title":"Harness Security Test Orchestration API","version":"1.0.0"},"tags":[{"name":"ScannerSettings","description":"Scanner settings stored per Harness scope, merged for scan-time consumers (Qwiet CLI)"}],"servers":[{"url":"https://app.harness.io/gateway/sto"},{"url":"http://127.0.0.1:4000"}],"security":[{"X-Api-Key_header_X-Api-Key":[],"jwt_header_Authorization":["sto_testtarget_edit"]}],"components":{"securitySchemes":{"X-Api-Key_header_X-Api-Key":{"type":"apiKey","name":"X-Api-Key","in":"header"},"jwt_header_Authorization":{"type":"http","scheme":"bearer"}},"schemas":{"RestoreScannerSettingsBody":{"type":"object","properties":{"blocks":{"type":"array","items":{"type":"string"},"description":"Top-level settings block names to remove from the viewed scope row."}},"required":["blocks"]},"ResolvedScannerSettings":{"type":"object","properties":{"metadata":{"$ref":"#/components/schemas/ScannerSettingsMetadata"},"overrides":{"type":"object","description":"Raw delta settings stored at the viewed scope. Empty when nothing is set there.","additionalProperties":true},"scope":{"type":"string","description":"Narrowest requested scope: ACCOUNT, ORG, PROJECT or TARGET."},"settings":{"type":"object","description":"Resolved settings merged across the scope chain.","additionalProperties":true},"sources":{"type":"object","description":"Top-level block name -> scope that last set it (DEFAULT, ACCOUNT, ORG, PROJECT or TARGET).","additionalProperties":{"type":"string"}}},"required":["scope","settings","sources","overrides","metadata"]},"ScannerSettingsMetadata":{"type":"object","properties":{"secret_detection_plugins":{"type":"array","items":{"$ref":"#/components/schemas/SecretDetectionPlugin"},"description":"Catalog of detect-secrets plugins. All are enabled unless their value is listed in the client-secrets disable-plugin setting. UI renders the checkbox list from this catalog and writes back only disabled values."},"skills_paths":{"type":"array","items":{"$ref":"#/components/schemas/SkillsPathSetting"},"description":"Effective AI skills directory paths with removable flags. Paths matching the CLI defaults are not removable; user-added paths are."}},"description":"UI affordance metadata for the scanner settings screen. Derived by the backend; not stored in scanner_setting and never sent to the Qwiet CLI.","required":["secret_detection_plugins","skills_paths"]},"SecretDetectionPlugin":{"type":"object","properties":{"label":{"type":"string","description":"Human-readable display name for the UI checkbox list."},"value":{"type":"string","description":"detect-secrets plugin name. This exact value goes into the client-secrets disable-plugin setting consumed by the Qwiet CLI."}},"description":"One detect-secrets plugin with its UI display label.","required":["value","label"]},"SkillsPathSetting":{"type":"object","properties":{"removable":{"type":"boolean","description":"False for Qwiet CLI default paths (they cannot be removed, only reordered after); true for user-added paths."},"value":{"type":"string","description":"The skills directory path, relative to the repository root."}},"description":"One AI skills directory path with UI affordance metadata.","required":["value","removable"]},"NotFound":{"type":"object","properties":{"message":{"type":"string"},"status":{"type":"integer","default":404,"format":"int64"}},"required":["message"]}}},"paths":{"/api/v2/scanner-settings/restore":{"post":{"tags":["ScannerSettings"],"summary":"Restore scanner settings blocks at scope","description":"Remove top-level settings blocks stored at the viewed Harness scope so effective values inherit from broader scopes. Deletes the scope row when no blocks remain.","operationId":"ScannerSettings#RestoreScannerSettings","parameters":[{"name":"accountId","in":"query","description":"Harness Account ID","allowEmptyValue":true,"required":true,"schema":{"type":"string","description":"Harness Account ID","pattern":"^[a-zA-Z0-9_-]{22}$"}},{"name":"orgId","in":"query","description":"Harness Organization ID","allowEmptyValue":true,"schema":{"type":"string","description":"Harness Organization ID","pattern":"^[A-Za-z_][A-Za-z0-9_]*$","maxLength":128}},{"name":"projectId","in":"query","description":"Harness Project ID","allowEmptyValue":true,"schema":{"type":"string","description":"Harness Project ID","pattern":"^[A-Za-z_][A-Za-z0-9_]*$","maxLength":128}},{"name":"productName","in":"query","description":"Seeded product.name whose id keys scanner_setting rows.","allowEmptyValue":true,"required":true,"schema":{"type":"string","description":"Seeded product.name whose id keys scanner_setting rows.","minLength":1,"maxLength":128}},{"name":"targetId","in":"query","description":"Optional Harness target ID. When set, the target scope is the viewed scope.","allowEmptyValue":true,"schema":{"type":"string","description":"Optional Harness target ID. When set, the target scope is the viewed scope.","pattern":"^[a-zA-Z0-9_-]{22}$"}},{"name":"X-Api-Key","in":"header","description":"Harness personal or service access token","allowEmptyValue":true,"schema":{"type":"string","description":"Harness personal or service access token"}}],"requestBody":{"required":true,"content":{"application/json":{"schema":{"$ref":"#/components/schemas/RestoreScannerSettingsBody"}}}},"responses":{"200":{"description":"OK response.","content":{"application/json":{"schema":{"$ref":"#/components/schemas/ResolvedScannerSettings"}}}},"400":{"description":"BadRequest: Bad Request response.","content":{"application/json":{"schema":{"$ref":"#/components/schemas/NotFound"}}}},"401":{"description":"Unauthorized: Unauthorized response.","content":{"application/json":{"schema":{"$ref":"#/components/schemas/NotFound"}}}},"403":{"description":"Forbidden: Forbidden response.","content":{"application/json":{"schema":{"$ref":"#/components/schemas/NotFound"}}}},"404":{"description":"NotFound: Not Found response.","content":{"application/json":{"schema":{"$ref":"#/components/schemas/NotFound"}}}},"429":{"description":"TooManyRequests: Too Many Requests response.","content":{"application/json":{"schema":{"$ref":"#/components/schemas/NotFound"}}}},"500":{"description":"InternalServerError: Internal Server Error response.","content":{"application/json":{"schema":{"$ref":"#/components/schemas/NotFound"}}}}}}}}}
```
