Skip to main content
PUT
Replace the organization's Scan Configuration

Authorizations

Authorization
string
header
required

An Earnie API key, sent as Authorization: Bearer sk_earnie_.... Create one under Settings > API keys. The key's scopes decide which operations it may call.

Body

application/json

One UI-editable layer of Scan Configuration — the organization-wide document or a project's document. Skip patterns and size rules exclude files before scanning on the next scan; Component overrides auto-resolve matches at scan time.

skip_patterns
string[]
required

Gitignore-style patterns excluded before scanning, unioned with scanner defaults and any repo scanoss.json skips.

skip_sizes
object[]
required

File-size rules excluded before scanning, unioned with any repo scanoss.json size rules.

component_overrides
object[]
required
self_check_wait_seconds
integer

Organization-only default synchronous Self-check wait, in seconds. Zero or omission uses the server default (45 seconds). A positive per-request wait_seconds overrides it. Project configuration cannot set a nonzero value. A timeout returns a running handle, not a failure.

Required range: 0 <= x <= 120
snippet_tuning
object

Snippet tuning for this layer. Optional on write, but the PUT replaces the whole document: a request that omits snippet_tuning resets every knob to inherit. Clients that edit another section must send back the tuning they read.

Response

Updated Scan Configuration

One UI-editable layer of Scan Configuration — the organization-wide document or a project's document. Skip patterns and size rules exclude files before scanning on the next scan; Component overrides auto-resolve matches at scan time.

skip_patterns
string[]
required

Gitignore-style patterns excluded before scanning, unioned with scanner defaults and any repo scanoss.json skips.

skip_sizes
object[]
required

File-size rules excluded before scanning, unioned with any repo scanoss.json size rules.

component_overrides
object[]
required
self_check_wait_seconds
integer

Organization-only default synchronous Self-check wait, in seconds. Zero or omission uses the server default (45 seconds). A positive per-request wait_seconds overrides it. Project configuration cannot set a nonzero value. A timeout returns a running handle, not a failure.

Required range: 0 <= x <= 120
snippet_tuning
object

Snippet tuning for this layer. Optional on write, but the PUT replaces the whole document: a request that omits snippet_tuning resets every knob to inherit. Clients that edit another section must send back the tuning they read.