Skip to main content
PUT
Replace the organization's pull-request controls

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

The organization layer of the same pull-request controls, plus the lock that decides whether they are advice or law. Unlocked — the default — this document is inert: every project answers for itself and these values are never consulted. It is deliberately not a set of inherited defaults, because that would silently change the behaviour of every project that had never saved its own settings. Locked, these values are in force for every project in the organization and project-level writes are refused. Project settings are left untouched, so unlocking restores what each project had chosen.

summary_comment
enum<string>
required

When the Earnie PR summary comment appears.

Available options:
always,
on_failure_only
inline_severity_floor
enum<string>
required

Lowest finding severity eligible for an inline review comment.

Available options:
critical,
high,
medium,
low,
info
inline_comment_cap
integer
required

Maximum inline comments in one COMMENT review.

Required range: 0 <= x <= 10
draft_pull_requests
enum<string>
required

What to do with a draft pull request.

Available options:
scan,
skip
bot_authors
enum<string>
required

What to do with a pull request opened by a provider bot account.

Available options:
scan,
skip
base_branch_filter
string[]
required

Allow-list of base-branch patterns; empty means every base branch.

Maximum array length: 50
path_filters
string[]
required

Allow-list of changed-file patterns; empty means every path.

Maximum array length: 50
locked
boolean
required

Whether these values are in force for every project in the organization. False leaves the document inert.

Response

The updated organization pull-request controls.

The organization layer of the same pull-request controls, plus the lock that decides whether they are advice or law. Unlocked — the default — this document is inert: every project answers for itself and these values are never consulted. It is deliberately not a set of inherited defaults, because that would silently change the behaviour of every project that had never saved its own settings. Locked, these values are in force for every project in the organization and project-level writes are refused. Project settings are left untouched, so unlocking restores what each project had chosen.

summary_comment
enum<string>
required

When the Earnie PR summary comment appears.

Available options:
always,
on_failure_only
inline_severity_floor
enum<string>
required

Lowest finding severity eligible for an inline review comment.

Available options:
critical,
high,
medium,
low,
info
inline_comment_cap
integer
required

Maximum inline comments in one COMMENT review.

Required range: 0 <= x <= 10
draft_pull_requests
enum<string>
required

What to do with a draft pull request.

Available options:
scan,
skip
bot_authors
enum<string>
required

What to do with a pull request opened by a provider bot account.

Available options:
scan,
skip
base_branch_filter
string[]
required

Allow-list of base-branch patterns; empty means every base branch.

Maximum array length: 50
path_filters
string[]
required

Allow-list of changed-file patterns; empty means every path.

Maximum array length: 50
locked
boolean
required

Whether these values are in force for every project in the organization. False leaves the document inert.