Scanner Settings
Scanner settings stored per Harness scope, merged for scan-time consumers (Qwiet CLI)
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.
Harness Account ID
abcdef1234567890ghijklPattern: ^[a-zA-Z0-9_-]{22}$Harness Organization ID
example_orgPattern: ^[A-Za-z_][A-Za-z0-9_]*$Harness Project ID
example_projectPattern: ^[A-Za-z_][A-Za-z0-9_]*$Seeded product.name whose id keys scanner_setting rows.
snykOptional Harness target ID. When set, the target scope is the viewed scope.
abcdef1234567890ghijklPattern: ^[a-zA-Z0-9_-]{22}$Harness personal or service access token
Eum repellat aspernatur non quaerat a.OK response.
Narrowest requested scope: ACCOUNT, ORG, PROJECT or TARGET.
PROJECTBadRequest: Bad Request response.
Unauthorized: Unauthorized response.
Forbidden: Forbidden response.
NotFound: Not Found response.
TooManyRequests: Too Many Requests response.
InternalServerError: Internal Server Error response.
PUT /gateway/sto/api/v2/scanner-settings?accountId=abcdef1234567890ghijkl&productName=snyk HTTP/1.1
Host: app.harness.io
X-Api-Key: YOUR_API_KEY
Authorization: Bearer YOUR_SECRET_TOKEN
Content-Type: application/json
Accept: */*
Content-Length: 139
{
"settings": {
"Tempora et non ut provident recusandae veniam.": "Velit et.",
"Temporibus ad illum.": "Exercitationem repellat commodi nulla."
}
}{
"metadata": {
"secret_detection_plugins": [
{
"label": "JSON Web Tokens (JWTs)",
"value": "JwtTokenDetector"
},
{
"label": "JSON Web Tokens (JWTs)",
"value": "JwtTokenDetector"
}
],
"skills_paths": [
{
"removable": false,
"value": ".claude/skills"
},
{
"removable": false,
"value": ".claude/skills"
},
{
"removable": false,
"value": ".claude/skills"
}
]
},
"overrides": {
"Et vel dicta eius et in.": "Ea quae.",
"Iure qui corporis.": "Aperiam consectetur qui laudantium dolores.",
"Libero quas voluptatum possimus doloribus expedita.": "Et id commodi."
},
"scope": "PROJECT",
"settings": {
"Pariatur qui qui sit.": "Aperiam at quo dolorem."
},
"sources": {
"Rerum sequi commodi asperiores laboriosam.": "Voluptatem quis dolorem qui quis minima."
}
}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.
Harness Account ID
abcdef1234567890ghijklPattern: ^[a-zA-Z0-9_-]{22}$Harness Organization ID
example_orgPattern: ^[A-Za-z_][A-Za-z0-9_]*$Harness Project ID
example_projectPattern: ^[A-Za-z_][A-Za-z0-9_]*$Seeded product.name whose id keys scanner_setting rows.
snykOptional Harness target ID. When set, target-scoped settings are included and win over broader scopes.
abcdef1234567890ghijklPattern: ^[a-zA-Z0-9_-]{22}$Harness personal or service access token
Voluptatem fugiat.OK response.
BadRequest: Bad Request response.
Unauthorized: Unauthorized response.
Forbidden: Forbidden response.
NotFound: Not Found response.
TooManyRequests: Too Many Requests response.
InternalServerError: Internal Server Error response.
GET /gateway/sto/api/v2/scanner-settings/merged?accountId=abcdef1234567890ghijkl&productName=snyk HTTP/1.1
Host: app.harness.io
X-Api-Key: YOUR_API_KEY
Authorization: Bearer YOUR_SECRET_TOKEN
Accept: */*
{
"Aut quaerat numquam ut at reprehenderit.": "Ipsa et incidunt laborum.",
"Est voluptate.": "Reiciendis consequatur.",
"Tempora iste esse et distinctio nulla.": "Eos accusamus qui recusandae molestiae repudiandae natus."
}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.
Harness Account ID
abcdef1234567890ghijklPattern: ^[a-zA-Z0-9_-]{22}$Harness Organization ID
example_orgPattern: ^[A-Za-z_][A-Za-z0-9_]*$Harness Project ID
example_projectPattern: ^[A-Za-z_][A-Za-z0-9_]*$Seeded product.name whose id keys scanner_setting rows.
snykOptional Harness target ID. When set, the target scope is the viewed scope.
abcdef1234567890ghijklPattern: ^[a-zA-Z0-9_-]{22}$Harness personal or service access token
Fuga quam vel ut qui et dolores.OK response.
Narrowest requested scope: ACCOUNT, ORG, PROJECT or TARGET.
PROJECTBadRequest: Bad Request response.
Unauthorized: Unauthorized response.
Forbidden: Forbidden response.
NotFound: Not Found response.
TooManyRequests: Too Many Requests response.
InternalServerError: Internal Server Error response.
GET /gateway/sto/api/v2/scanner-settings/resolved?accountId=abcdef1234567890ghijkl&productName=snyk HTTP/1.1
Host: app.harness.io
X-Api-Key: YOUR_API_KEY
Authorization: Bearer YOUR_SECRET_TOKEN
Accept: */*
{
"metadata": {
"secret_detection_plugins": [
{
"label": "JSON Web Tokens (JWTs)",
"value": "JwtTokenDetector"
},
{
"label": "JSON Web Tokens (JWTs)",
"value": "JwtTokenDetector"
}
],
"skills_paths": [
{
"removable": false,
"value": ".claude/skills"
},
{
"removable": false,
"value": ".claude/skills"
},
{
"removable": false,
"value": ".claude/skills"
}
]
},
"overrides": {
"Omnis unde quo pariatur maxime cupiditate quisquam.": "Est consequatur."
},
"scope": "PROJECT",
"settings": {
"Porro sit unde qui culpa.": "Voluptas quidem eveniet doloribus corrupti corrupti vitae.",
"Repellendus repellat quas quos in.": "Quia dolorum quaerat quam ab dolorum maiores."
},
"sources": {
"Dolorum blanditiis ut delectus consequatur ratione repellendus.": "Occaecati non vitae exercitationem perspiciatis.",
"Nam velit impedit doloremque dolor officia et.": "Ipsum sed."
}
}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.
Harness Account ID
abcdef1234567890ghijklPattern: ^[a-zA-Z0-9_-]{22}$Harness Organization ID
example_orgPattern: ^[A-Za-z_][A-Za-z0-9_]*$Harness Project ID
example_projectPattern: ^[A-Za-z_][A-Za-z0-9_]*$Seeded product.name whose id keys scanner_setting rows.
snykOptional Harness target ID. When set, the target scope is the viewed scope.
abcdef1234567890ghijklPattern: ^[a-zA-Z0-9_-]{22}$Harness personal or service access token
Repellendus dolore voluptatum aspernatur nulla omnis expedita.Top-level settings block names to remove from the viewed scope row.
["Qui cum illo earum quia.","Autem repellendus nemo.","Similique voluptates ipsam nesciunt rerum qui aspernatur."]OK response.
Narrowest requested scope: ACCOUNT, ORG, PROJECT or TARGET.
PROJECTBadRequest: Bad Request response.
Unauthorized: Unauthorized response.
Forbidden: Forbidden response.
NotFound: Not Found response.
TooManyRequests: Too Many Requests response.
InternalServerError: Internal Server Error response.
POST /gateway/sto/api/v2/scanner-settings/restore?accountId=abcdef1234567890ghijkl&productName=snyk HTTP/1.1
Host: app.harness.io
X-Api-Key: YOUR_API_KEY
Authorization: Bearer YOUR_SECRET_TOKEN
Content-Type: application/json
Accept: */*
Content-Length: 129
{
"blocks": [
"In aspernatur repellendus vero occaecati ut adipisci.",
"Saepe quis earum quia iste.",
"Delectus vel voluptate quia."
]
}{
"metadata": {
"secret_detection_plugins": [
{
"label": "JSON Web Tokens (JWTs)",
"value": "JwtTokenDetector"
},
{
"label": "JSON Web Tokens (JWTs)",
"value": "JwtTokenDetector"
}
],
"skills_paths": [
{
"removable": false,
"value": ".claude/skills"
},
{
"removable": false,
"value": ".claude/skills"
},
{
"removable": false,
"value": ".claude/skills"
}
]
},
"overrides": {
"Eius fugit sed autem doloremque quidem.": "Et sint laborum aut quis quia.",
"Sit nam dolorem nostrum.": "Harum aut ad."
},
"scope": "PROJECT",
"settings": {
"Autem ratione sunt eveniet perferendis.": "Omnis qui qui sequi.",
"Et et suscipit qui maxime.": "Consectetur optio ullam occaecati odio.",
"Sint rem reiciendis molestiae.": "Quia error error."
},
"sources": {
"Et cumque ratione molestiae.": "Minima laboriosam sit esse quaerat.",
"Quis nam.": "Id natus.",
"Rem nihil amet ut exercitationem.": "Et impedit eos."
}
}Last updated
Was this helpful?