Skip to main content
GET
Get the organization's PR/MR review settings: whether reviews post comments, the severity that fails the PR check, and which PRs are reviewed
Returns the PR review settings configured for your organization under Settings in Hacktron:
  • scm_comments_enabled: reviews post comments and finding details on pull and merge requests.
  • scm_system_comments_enabled: reviews also post system comments, such as skipped reviews, usage limits and configuration warnings.
  • fail_on_severity: the severity at or above which a finding fails the PR check, or null when it never fails.
  • scan_include_* and scan_exclude_*: which pull requests are reviewed, by target branch, label, author and title keyword. null means no filter.
A repository’s .hacktron/config.yaml takes precedence over these defaults. To check whether reviews are enabled for a repository, read its prScansEnabled value from List repositories.
Scope required: read

Authorizations

X-Api-Key
string
header
required

Headers

X-Organization-Id
string
required

Organization ID

Response

200 - application/json
scm_comments_enabled
boolean

Whether Hacktron publishes comments and finding details to connected source control pull and merge requests

scm_system_comments_enabled
boolean

Whether Hacktron posts system comments such as skipped reviews, usage limits, and configuration warnings. Defaults to true. Requires scm_comments_enabled.

fail_on_severity
enum<string> | null

Org-wide default fail_on severity threshold for PR/MR checks. A repo's .hacktron/config.yaml fail_on.severity overrides this. Send null to disable.

Available options:
critical,
high,
medium,
low,
info
scan_include_branches
string[] | null

Org-wide default target branch patterns to scan PRs/MRs for (null = all branches). Glob patterns (*, **, ?, {a,b}), case-insensitive. A repo's .hacktron/config.yaml include.branches overrides this.

Example:
scan_exclude_branches
string[] | null

Org-wide default target branch patterns to exclude from PR/MR scans (null = none). Takes precedence over scan_include_branches. A repo's .hacktron/config.yaml exclude.branches overrides this.

Example:
scan_include_labels
string[] | null

Org-wide default labels to require on PRs/MRs for scanning (null = any). A repo's .hacktron/config.yaml include.labels overrides this.

Example:
scan_exclude_labels
string[] | null

Org-wide default labels to exclude PR/MR scans for (null = none). Takes precedence over scan_include_labels. A repo's .hacktron/config.yaml exclude.labels overrides this.

Example:
scan_include_authors
string[] | null

Org-wide default author patterns to require on PRs/MRs for scanning (null = any). Glob patterns (*, **, ?, {a,b}), case-insensitive. A repo's .hacktron/config.yaml include.authors overrides this.

Example:
scan_exclude_authors
string[] | null

Org-wide default author patterns to exclude PR/MR scans for (null = none). Glob patterns (*, **, ?, {a,b}), case-insensitive. Takes precedence over scan_include_authors. A repo's .hacktron/config.yaml exclude.authors overrides this.

Example:
scan_include_keywords
string[] | null

Org-wide default title keywords to require on PRs/MRs for scanning (null = any). Case-insensitive substring match. A repo's .hacktron/config.yaml include.keywords overrides this.

Example:
scan_exclude_keywords
string[] | null

Org-wide default title keywords to exclude PR/MR scans for (null = none). Case-insensitive substring match. A repo's .hacktron/config.yaml exclude.keywords overrides this.

Example: