Ctrlk
Book a demoOX Security
For the complete documentation index, see llms.txt. This page is also available as Markdown.

setPipelineScanSettingsInput

Input payload for updating pipeline scan settings for applications.

Examples

input SetPipelineScanSettingsInput {
  appIds: [String!]!
  timeout: Float
  performance: String
  failOnTimeout: Boolean
  failOnError: Boolean
  scansEnabled: Boolean!
  scanSummaryAsCommentEnabled: Boolean
  scanSummaryShowSuccess: Boolean
  eventsTriggeringScansForBranches: [EventsTriggeringScansForBranchesSettingInput!]
  scansEnabledForBitbucketApp: Boolean
  scanSummaryAsCommentEnabledForBitbucketApp: Boolean
  eventsTriggeringScansForBranchesForBitbucketApp: [EventsTriggeringScansForBranchesSettingInput!]
  scansEnabledForGitLabWebhooks: Boolean
  eventsTriggeringScansForBranchesForGitLabWebhooks: [EventsTriggeringScansForBranchesSettingInput!]
}

Fields

Field
Description
Supported fields

appIds [String!]!

Application IDs to update settings for.

timeout Float

General Setting. Scan timeout value in minutes

performance String

General Setting. Scan speed

failOnTimeout Boolean

General Setting. Whether or not a scan timeout causes a scan to fail (block)

failOnError Boolean

General Setting. Whether or not an error (i.e. network, infrastructure) causes a scan to fail (block)

scansEnabled Boolean!

GitHub App Setting. Whether or not GitHub Checks should be run for the repository (application)

scanSummaryAsCommentEnabled Boolean

GitHub App Setting. Whether or not GitHub Checks results should be published in a pull request comments

scanSummaryShowSuccess Boolean

General Setting. When enabled, a comment is also posted when the scan finds no issues.

eventsTriggeringScansForBranches [EventsTriggeringScansForBranchesSettingInput!]

GitHub App Setting. Which events for which branches should trigger GitHub Checks

branchNamePatternBranchSelection String genericOptionBranchSelection GenericOptionBranchSelectionType events [TriggeringEventInput!]!

scansEnabledForBitbucketApp Boolean

Bitbucket App Setting. Whether or not scans should be run and reported to Bitbucket APIs for the repository (application)

scanSummaryAsCommentEnabledForBitbucketApp Boolean

Bitbucket App Setting. Whether or not scan results should be published in a pull request comment

eventsTriggeringScansForBranchesForBitbucketApp [EventsTriggeringScansForBranchesSettingInput!]

Bitbucket App Setting. Which events for which branches should trigger scans

branchNamePatternBranchSelection String genericOptionBranchSelection GenericOptionBranchSelectionType events [TriggeringEventInput!]!

scansEnabledForGitLabWebhooks Boolean

GitLab Webhooks Setting. Whether or not scans should be run and reported to GitLab APIs for the project (application)

eventsTriggeringScansForBranchesForGitLabWebhooks [EventsTriggeringScansForBranchesSettingInput!]

GitLab Webhooks Setting. Which events for which branches should trigger scans

branchNamePatternBranchSelection String genericOptionBranchSelection GenericOptionBranchSelectionType events [TriggeringEventInput!]!

References

Mutations using this object:

Last updated