AIaikido

List PR Checks configurations

Returns a paginated list of all the CI checks configurations in your account

get/repositories/code/continuous_integration/checks

Request

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

Query parameters

pageinteger

Pagination parameter, starts at 0.

per_pageinteger

Amount of items returned

filter_code_repo_idinteger

Only return the configuration for the given code repository id

Response

A list of CI checks configurations

idinteger required

The id of the CI checks configuration.

code_repo_idinteger required

The id of the related code repo.

minimum_severity'low' | 'medium' | 'high' | 'critical' | 'always_pass_check'

Minimum severity of new issues for when the CI Check should fail.

fail_on_dependency_scanboolean

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

fail_on_sast_scanboolean

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

fail_on_iac_scanboolean

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

fail_on_secrets_scanboolean

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

fail_on_malware_scanboolean

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.

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.

fail_on_code_quality_scanboolean

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

enable_code_quality_scanboolean

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.

Example response

{
  "id": 1,
  "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": "low",
  "run_deep_audit_pr_scan": true
}

Changes

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