---
title: "Configure default PR Checks"
method: POST
path: "/repositories/code/continuous_integration/checks/default"
---

# Configure default PR Checks

`POST /repositories/code/continuous_integration/checks/default`

## Request

- Base URL: `https://app.aikido.dev/api/public/v1`
- URL: `https://app.aikido.dev/api/public/v1/repositories/code/continuous_integration/checks/default`
- Auth: OAuth 2
  - Client credentials
  - Token URL: `https://app.aikido.io/api/oauth/token` scopes: `repositories:write`

Create or update the workspace default PR Checks configuration. This configuration is applied to newly activated repositories that do not have a repo-specific configuration. It does not update existing repo configurations.

The default configuration is considered enabled when at least one of the following is true: fail_on_dependency_scan, fail_on_sast_scan, fail_on_iac_scan, fail_on_secrets_scan, fail_on_malware_scan, enable_code_quality_scan, or run_deep_audit_pr_scan. If all of those are false, the default configuration is removed.

Enabling a default configuration requires a paying account. Deep Review (run_deep_audit_pr_scan) is only available in the EU and US regions and requires at least one vulnerability scan type to be enabled.

## Request body

- object
  - `minimum_severity` 'low' | 'medium' | 'high' | 'critical' | 'always_pass_check', required: Minimum severity of new issues for when the CI Check should fail
  - `fail_on_dependency_scan` boolean, required: Boolean representing if the CI Check should fail for new dependency issues
  - `fail_on_sast_scan` boolean, required: Boolean representing if the CI Check should fail for new sast issues
  - `fail_on_iac_scan` boolean, required: Boolean representing if the CI Check should fail for new iac issues
  - `fail_on_secrets_scan` boolean, required: Boolean representing if the CI Check should fail for new secret issues
  - `fail_on_malware_scan` boolean, required: Boolean representing if the CI Check should fail for new malware issues
  - `post_inline_comments_min_severity` 'none' | 'low' | 'medium' | 'high' | 'critical': Minimum severity of new issues for when inline comments should be posted. Use 'none' or omit to disable inline comments. Default is 'none'.
  - `minimum_license_severity` 'none' | 'high' | 'critical': Minimum severity of new license issues for when the CI Check should fail. 'none' means the CI Check will not fail for any new license issues. Only applied when the CI license scan product feature is enabled.
  - `enable_code_quality_scan` boolean, required: Boolean representing if the code quality scan is enabled. When false, `fail_on_code_quality_scan` is forced to false and code quality inline comments are disabled.
  - `fail_on_code_quality_scan` boolean, required: Boolean representing if the CI Check should fail for new code quality issues. Ignored when `enable_code_quality_scan` is false.
  - `post_code_quality_inline_comments_min_severity` 'low' | 'medium' | 'high' | 'critical': Minimum severity of new code quality issues for when inline comments should be posted. Defaults to 'low' when code quality is enabled. Ignored when `enable_code_quality_scan` is false.
  - `run_deep_audit_pr_scan` boolean: Boolean representing if Deep Review should be run on pull requests. Defaults to false. Requires at least one vulnerability scan type to be enabled, and is only available in the EU and US regions.

## Response `200`

The default PR Checks configuration was updated.

- object
  - `status` 'ok': The string 'ok' indicating success

## Other responses

- `400`: Invalid configuration (for example Deep Review outside the EU or US regions, or Deep Review without a vulnerability scan type enabled).

---

[API](https://skmtc.dev/aikido/apis/aikido-security-api-documentation.md) - [All operations](https://skmtc.dev/aikido/apis/aikido-security-api-documentation/llms.txt) - [OpenAPI document](https://skmtc.dev/aikido/apis/aikido-security-api-documentation/revisions/da8691338133?raw)