v1

latestOpenAPI 3.1.02026-07-261690320.7 KB

Configure PR Checks

post/repositories/code/continuous_integration/checks

Request body

code_repo_idinteger required

The ID of the related code repo

minimum_severity'low' | 'medium' | 'high' | 'critical' 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

post_inline_comments_min_severity'none' | 'low' | 'medium' | 'high' | 'critical'

Minimum severity of new issues for when inline comments should be posted. Default is 'none'

minimum_license_severity'none' | 'high' | 'critical' required

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

fail_on_code_quality_scanboolean required

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

enable_code_quality_scanboolean required

Boolean representing if the code quality scan is enabled

Example request

{
  "code_repo_id": 1,
  "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,
  "post_inline_comments_min_severity": "critical",
  "minimum_license_severity": "high",
  "fail_on_code_quality_scan": true,
  "enable_code_quality_scan": true,
  "post_code_quality_inline_comments_min_severity": "medium"
}

Response

The CI checks configurations are updated.

successinteger

The integer 1 indicating success

Example response

{
  "success": 1
}