Skip to main content
PATCH
Error

Authorizations

​
Authorization
string
header
required

API token obtained from the Tokens endpoint or CLI device login. Include as Authorization: Bearer <token>. Requests made with a managed CLI session also include X-Strix-Workspace: <organization_id> to pin a process to the workspace it started in; recovery endpoints report the current workspace after a concurrent switch.

Body

application/json

Partial settings update. Supply at least one property; omitted settings keep their current values.

​
exclude_bots
boolean

Skip PRs opened by bot authors.

​
excluded_authors
string[]

Full replacement list of author logins to exclude from automatic review.

Maximum array length: 500
​
reviewed_bots
string[]

Full replacement list of bot logins to review even when exclude_bots is true.

Maximum array length: 200
​
review_on_push
boolean

Re-review when new commits are pushed.

​
target_branches
string[]

Branch-name patterns (single * wildcard, case-insensitive) that limit automatic reviews to matching base branches. An empty array reviews all branches.

Maximum array length: 100
​
allow_overage
boolean

Permit reviews beyond the plan limit.

​
overage_review_cap
integer | null

Maximum reviews when overage is allowed. Send null for no cap.

Required range: x >= 51
​
block_on_findings
boolean

When true, findings with a severity in blocking_severities submit a blocking review. When false, findings never block.

​
blocking_severities
enum<string>[]

Finding severities that trigger a blocking review when block_on_findings is true.

Maximum array length: 4
Available options:
critical,
high,
medium,
low
​
approve_clean_prs
boolean

When true, submit a GitHub approval on a clean PR instead of only a passing commit status.

Response

Updated settings.

Stored per-organization automatic PR review configuration.

​
organization_id
string
required
​
exclude_bots
boolean
required

Skip PRs opened by bot authors.

​
excluded_authors
string[]
required

Author logins to exclude from automatic review.

Maximum array length: 500
​
reviewed_bots
string[]
required

Bot logins to review despite exclude_bots.

Maximum array length: 200
​
review_on_push
boolean
required

Re-review when new commits are pushed.

​
allow_overage
boolean
required

Permit reviews beyond the plan limit.

​
overage_review_cap
integer | null
required

Maximum reviews when overage is allowed. A null value means no cap.

Required range: x >= 51
​
block_on_findings
boolean
required

When true (default), a review whose findings include a severity in blocking_severities submits a blocking review (GitHub REQUEST_CHANGES / failed status). When false, findings never block.

​
blocking_severities
enum<string>[]
required

Finding severities that trigger a blocking review when block_on_findings is enabled. Defaults to critical and high.

Maximum array length: 4
Available options:
critical,
high,
medium,
low
​
approve_clean_prs
boolean
required

When true, submit a GitHub approval on a clean PR instead of a silent commit-status-only pass.

​
target_branches
string[]
required

Branch-name patterns (single * wildcard, case-insensitive) restricting automatic reviews to PRs whose base/target branch matches. Empty array reviews all branches.

Maximum array length: 100
​
updated_by
string | null
required
​
updated_at
string<date-time> | null
required
​
success
boolean
required