AIaikido

Configure PR Checks for all repos

Configure PR Checks for all active repositories in the account. Currently only supports GitHub.

post/repositories/code/continuous_integration/checks/all

Request

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

Request body

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

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

run_deep_audit_pr_scanboolean

Boolean representing if the deep audit scan should be run on pull requests

excluded_reposinteger[]

Array of repository IDs to exclude from the bulk configuration.

Example request

{
  "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",
  "run_deep_audit_pr_scan": true,
  "excluded_repos": [
    1,
    2,
    3
  ]
}

Response

The CI checks configurations are updated.

statusstring

The status of the request

Example response

{
  "status": "ok"
}

Changes

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