getPipelineScanSettings

Examples

GraphQL

query GetPipelineScanSettings($input: GetPipelineScanSettingsInput!) {
  getPipelineScanSettings(input: $input) {
    timeout {
      option
      count
    }
    failOnTimeout {
      true
      false
    }
    failOnError {
      true
      false
    }
    performance {
      type
      count
      tooltip
    }
    scansEnabled {
      true
      false
    }
    scanSummaryAsCommentEnabled {
      true
      false
    }
    eventsTriggeringScansForBranches {
      branchNamePatternBranchSelection
      genericOptionBranchSelection
      events {
        type
        value {
          true
          false
        }
        label
      }
    }
    scansEnabledForBitbucketApp {
      true
      false
    }
    eventsTriggeringScansForBranchesForBitbucketApp {
      branchNamePatternBranchSelection
      genericOptionBranchSelection
      events {
        type
        value {
          true
          false
        }
        label
      }
    }
    scansEnabledForGitLabWebhooks {
      true
      false
    }
    eventsTriggeringScansForBranchesForGitLabWebhooks {
      branchNamePatternBranchSelection
      genericOptionBranchSelection
      events {
        type
        value {
          true
          false
        }
        label
      }
    }
  }
}

Variables

This is an example input showing all available input fields. Only fields marked as required in the schema are mandatory.

{
  "input": {
    "appIds": ["30966426"]
  }
}

cURL

Node.js

Python

Arguments

You can use the following argument(s) to customize your getPipelineScanSettings query.

Argument	Description	Supported fields
input GetPipelineScanSettingsInput! required		appIds [String!]!

Fields

Return type: GetPipelineScanSettingsResponse!

You can use the following field(s) to specify what information your getPipelineScanSettings query will return. Please note that some fields may have their own subfields.

Field	Description	Supported fields
timeout [NumericSettingResponse!]!	General Setting. Scan timeout value in minutes	option Float! count Float!
failOnTimeout BooleanSettingResponse!	General Setting. Whether or not a scan timeout causes a scan to fail (block)	true Float! false Float!
failOnError BooleanSettingResponse!	General Setting. Whether or not an error (i.e. network, infrastructure) causes a scan to fail (block)	true Float! false Float!
performance [ScanTypeSettingResponse!]!	General Setting. Scan speed	type String! count Float! tooltip String!
scansEnabled BooleanSettingResponse!	GitHub App Setting. Whether or not GitHub Checks should be run for the repository (application)	true Float! false Float!
scanSummaryAsCommentEnabled BooleanSettingResponse!	GitHub App Setting. Whether or not GitHub Checks results should be published in a pull request comments	true Float! false Float!
eventsTriggeringScansForBranches [EventsTriggeringScansForBranchesSettingResponse!]!	GitHub App Setting. Which events for which branches should trigger GitHub Checks	branchNamePatternBranchSelection String genericOptionBranchSelection GenericOptionBranchSelectionType events [TriggeringEventResponse!]!
scansEnabledForBitbucketApp BooleanSettingResponse!	Bitbucket App Setting. Whether or not scans should be run and reported to Bitbucket APIs for the repository (application)	true Float! false Float!
eventsTriggeringScansForBranchesForBitbucketApp [EventsTriggeringScansForBranchesSettingResponse!]!	Bitbucket App Setting. Which events for which branches should trigger scans	branchNamePatternBranchSelection String genericOptionBranchSelection GenericOptionBranchSelectionType events [TriggeringEventResponse!]!
scansEnabledForGitLabWebhooks BooleanSettingResponse!	GitLab Webhooks Setting. Whether or not scans should be run and reported to GitLab APIs for the project (application)	true Float! false Float!
eventsTriggeringScansForBranchesForGitLabWebhooks [EventsTriggeringScansForBranchesSettingResponse!]!	GitLab Webhooks Setting. Which events for which branches should trigger scans	branchNamePatternBranchSelection String genericOptionBranchSelection GenericOptionBranchSelectionType events [TriggeringEventResponse!]!