Skip to content
For the complete documentation index, see llms.txt. This page is also available as Markdown.

Scanner Settings

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

Update scanner settings at scope

put
/api/v2/scanner-settings

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.

Required scopes
This endpoint requires the following scopes:
Authorizations
X-Api-KeystringRequired
AuthorizationstringRequired
Bearer authentication header of the form Bearer <token>.
Query parameters
accountIdstringRequired

Harness Account ID

Example: abcdef1234567890ghijklPattern: ^[a-zA-Z0-9_-]{22}$
orgIdstring · max: 128Optional

Harness Organization ID

Example: example_orgPattern: ^[A-Za-z_][A-Za-z0-9_]*$
projectIdstring · max: 128Optional

Harness Project ID

Example: example_projectPattern: ^[A-Za-z_][A-Za-z0-9_]*$
productNamestring · min: 1 · max: 128Required

Seeded product.name whose id keys scanner_setting rows.

Example: snyk
targetIdstringOptional

Optional Harness target ID. When set, the target scope is the viewed scope.

Example: abcdef1234567890ghijklPattern: ^[a-zA-Z0-9_-]{22}$
Header parameters
X-Api-KeystringOptional

Harness personal or service access token

Example: Eum repellat aspernatur non quaerat a.
Body
Responses
200

OK response.

application/json
scopestringRequired

Narrowest requested scope: ACCOUNT, ORG, PROJECT or TARGET.

Example: PROJECT
put/api/v2/scanner-settings
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."
  }
}

Get merged scanner settings

get
/api/v2/scanner-settings/merged

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.

Required scopes
This endpoint requires the following scopes:
Authorizations
X-Api-KeystringRequired
AuthorizationstringRequired
Bearer authentication header of the form Bearer <token>.
Query parameters
accountIdstringRequired

Harness Account ID

Example: abcdef1234567890ghijklPattern: ^[a-zA-Z0-9_-]{22}$
orgIdstring · max: 128Optional

Harness Organization ID

Example: example_orgPattern: ^[A-Za-z_][A-Za-z0-9_]*$
projectIdstring · max: 128Optional

Harness Project ID

Example: example_projectPattern: ^[A-Za-z_][A-Za-z0-9_]*$
productNamestring · min: 1 · max: 128Required

Seeded product.name whose id keys scanner_setting rows.

Example: snyk
targetIdstringOptional

Optional Harness target ID. When set, target-scoped settings are included and win over broader scopes.

Example: abcdef1234567890ghijklPattern: ^[a-zA-Z0-9_-]{22}$
Header parameters
X-Api-KeystringOptional

Harness personal or service access token

Example: Voluptatem fugiat.
Responses
200

OK response.

application/json
Other propertiesanyOptional
get/api/v2/scanner-settings/merged
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."
}

Get resolved scanner settings with provenance

get
/api/v2/scanner-settings/resolved

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.

Required scopes
This endpoint requires the following scopes:
Authorizations
X-Api-KeystringRequired
AuthorizationstringRequired
Bearer authentication header of the form Bearer <token>.
Query parameters
accountIdstringRequired

Harness Account ID

Example: abcdef1234567890ghijklPattern: ^[a-zA-Z0-9_-]{22}$
orgIdstring · max: 128Optional

Harness Organization ID

Example: example_orgPattern: ^[A-Za-z_][A-Za-z0-9_]*$
projectIdstring · max: 128Optional

Harness Project ID

Example: example_projectPattern: ^[A-Za-z_][A-Za-z0-9_]*$
productNamestring · min: 1 · max: 128Required

Seeded product.name whose id keys scanner_setting rows.

Example: snyk
targetIdstringOptional

Optional Harness target ID. When set, the target scope is the viewed scope.

Example: abcdef1234567890ghijklPattern: ^[a-zA-Z0-9_-]{22}$
Header parameters
X-Api-KeystringOptional

Harness personal or service access token

Example: Fuga quam vel ut qui et dolores.
Responses
200

OK response.

application/json
scopestringRequired

Narrowest requested scope: ACCOUNT, ORG, PROJECT or TARGET.

Example: PROJECT
get/api/v2/scanner-settings/resolved
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."
  }
}

Restore scanner settings blocks at scope

post
/api/v2/scanner-settings/restore

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.

Required scopes
This endpoint requires the following scopes:
Authorizations
X-Api-KeystringRequired
AuthorizationstringRequired
Bearer authentication header of the form Bearer <token>.
Query parameters
accountIdstringRequired

Harness Account ID

Example: abcdef1234567890ghijklPattern: ^[a-zA-Z0-9_-]{22}$
orgIdstring · max: 128Optional

Harness Organization ID

Example: example_orgPattern: ^[A-Za-z_][A-Za-z0-9_]*$
projectIdstring · max: 128Optional

Harness Project ID

Example: example_projectPattern: ^[A-Za-z_][A-Za-z0-9_]*$
productNamestring · min: 1 · max: 128Required

Seeded product.name whose id keys scanner_setting rows.

Example: snyk
targetIdstringOptional

Optional Harness target ID. When set, the target scope is the viewed scope.

Example: abcdef1234567890ghijklPattern: ^[a-zA-Z0-9_-]{22}$
Header parameters
X-Api-KeystringOptional

Harness personal or service access token

Example: Repellendus dolore voluptatum aspernatur nulla omnis expedita.
Body
blocksstring[]Required

Top-level settings block names to remove from the viewed scope row.

Example: ["Qui cum illo earum quia.","Autem repellendus nemo.","Similique voluptates ipsam nesciunt rerum qui aspernatur."]
Responses
200

OK response.

application/json
scopestringRequired

Narrowest requested scope: ACCOUNT, ORG, PROJECT or TARGET.

Example: PROJECT
post/api/v2/scanner-settings/restore
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?