AIaikido

Get default PR Checks configuration

Returns the workspace default PR Checks configuration. This configuration is applied to newly activated repositories that do not have a repo-specific configuration. When no default configuration exists, fallback values are returned.

get/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:read

Response

The default PR Checks configuration

is_enabledboolean required

Boolean representing if the default PR Checks configuration is enabled. When the value is false, all other fields are disabled. When the vlaue is true, one or more fields may be enabled.

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_scanboolean required

Boolean representing if the CI Check should fail for new dependency issues.

fail_on_sast_scanboolean required

Boolean representing if the CI Check should fail for new sast issues.

fail_on_iac_scanboolean required

Boolean representing if the CI Check should fail for new iac issues.

fail_on_secrets_scanboolean required

Boolean representing if the CI Check should fail for new secret issues.

fail_on_malware_scanboolean required

Boolean representing if the CI Check should fail for new malware issues.

fail_on_license_scanboolean

Boolean representing if the CI Check should fail for new license issues. Derived from minimum_license_severity.

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.

post_inline_commentsboolean

Boolean representing if inline comments should be posted for vulnerability findings.

post_inline_comments_min_severity'low' | 'medium' | 'high' | 'critical' | 'null' nullable

Minimum severity of new issues for when inline comments should be posted. Null when inline comments are disabled.

enable_code_quality_scanboolean required

Boolean representing if the code quality scan is enabled.

post_code_quality_inline_comments_min_severity'none' | 'low' | 'medium' | 'high' | 'critical'

Minimum severity of new code quality issues for when inline comments should be posted. 'none' means code quality is disabled.

fail_on_code_quality_scanboolean required

Boolean representing if the CI Check should fail for new code quality issues.

run_deep_audit_pr_scanboolean

Boolean representing if Deep Review should be run on pull requests.

Example response

{
  "is_enabled": true,
  "minimum_severity": "high",
  "fail_on_dependency_scan": true,
  "fail_on_sast_scan": true,
  "fail_on_iac_scan": true,
  "fail_on_secrets_scan": true,
  "fail_on_malware_scan": true,
  "fail_on_license_scan": true,
  "minimum_license_severity": "high",
  "post_inline_comments": true,
  "post_inline_comments_min_severity": "critical",
  "enable_code_quality_scan": true,
  "post_code_quality_inline_comments_min_severity": "low",
  "fail_on_code_quality_scan": true,
  "run_deep_audit_pr_scan": true
}

Changes

No recorded changes to this operation across all 1 revision of this API.