setPipelineScanSettings

Examples

GraphQL

mutation SetPipelineScanSettings($input: SetPipelineScanSettingsInput!) {
  setPipelineScanSettings(input: $input) {
    success
  }
}

Variables

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

{
  "input": {
    "appIds": ["30966426"],
    "timeout": 13.37,
    "performance": "example",
    "failOnTimeout": true,
    "failOnError": true,
    "scansEnabled": true,
    "scanSummaryAsCommentEnabled": true,
    "scanSummaryShowSuccess": true,
    "eventsTriggeringScansForBranches": [
      {
        "branchNamePatternBranchSelection": "example",
        "genericOptionBranchSelection": "defaultBranch",
        "events": [
          {
            "type": "pullRequest",
            "value": true
          }
        ]
      }
    ],
    "scansEnabledForBitbucketApp": true,
    "scanSummaryAsCommentEnabledForBitbucketApp": true,
    "eventsTriggeringScansForBranchesForBitbucketApp": [
      {
        "branchNamePatternBranchSelection": "example",
        "genericOptionBranchSelection": "defaultBranch",
        "events": [
          {
            "type": "pullRequest",
            "value": true
          }
        ]
      }
    ],
    "scansEnabledForGitLabWebhooks": true,
    "eventsTriggeringScansForBranchesForGitLabWebhooks": [
      {
        "branchNamePatternBranchSelection": "example",
        "genericOptionBranchSelection": "defaultBranch",
        "events": [
          {
            "type": "pullRequest",
            "value": true
          }
        ]
      }
    ]
  }
}

cURL

curl -X POST \
https://api.cloud.ox.security/api/apollo-gateway \
-H 'Content-Type: application/json' \
-H 'Authorization: YOUR_API_TOKEN' \
-d '{
 "query": "mutation SetPipelineScanSettings($input: SetPipelineScanSettingsInput!) { setPipelineScanSettings(input: $input) { success } }",
 "variables": {
    "input": {
      "appIds": ["30966426"],
      "timeout": 13.37,
      "performance": "example",
      "failOnTimeout": true,
      "failOnError": true,
      "scansEnabled": true,
      "scanSummaryAsCommentEnabled": true,
      "scanSummaryShowSuccess": true,
      "eventsTriggeringScansForBranches": [
        {
          "branchNamePatternBranchSelection": "example",
          "genericOptionBranchSelection": "defaultBranch",
          "events": [
            {
              "type": "pullRequest",
              "value": true
            }
          ]
        }
      ],
      "scansEnabledForBitbucketApp": true,
      "scanSummaryAsCommentEnabledForBitbucketApp": true,
      "eventsTriggeringScansForBranchesForBitbucketApp": [
        {
          "branchNamePatternBranchSelection": "example",
          "genericOptionBranchSelection": "defaultBranch",
          "events": [
            {
              "type": "pullRequest",
              "value": true
            }
          ]
        }
      ],
      "scansEnabledForGitLabWebhooks": true,
      "eventsTriggeringScansForBranchesForGitLabWebhooks": [
        {
          "branchNamePatternBranchSelection": "example",
          "genericOptionBranchSelection": "defaultBranch",
          "events": [
            {
              "type": "pullRequest",
              "value": true
            }
          ]
        }
      ]
    }
  }
}'

Node.js

const query = 'mutation SetPipelineScanSettings($input: SetPipelineScanSettingsInput!) { setPipelineScanSettings(input: $input) { success } }';

fetch("https://api.cloud.ox.security/api/apollo-gateway", {
  method: "POST",
  headers: {
    "Content-Type": "application/json",
    "Authorization": "YOUR_API_TOKEN"
  },
  body: JSON.stringify({
    query: query,
    // This is an example input showing all available input fields. Only fields marked as required in the schema are mandatory.
    variables: {
      input: {
        appIds: ["30966426"],
        timeout: 13.37,
        performance: "example",
        failOnTimeout: true,
        failOnError: true,
        scansEnabled: true,
        scanSummaryAsCommentEnabled: true,
        scanSummaryShowSuccess: true,
        eventsTriggeringScansForBranches: [
          {
            branchNamePatternBranchSelection: "example",
            genericOptionBranchSelection: "defaultBranch",
            events: [
              {
                type: "pullRequest",
                value: true
              }
            ]
          }
        ],
        scansEnabledForBitbucketApp: true,
        scanSummaryAsCommentEnabledForBitbucketApp: true,
        eventsTriggeringScansForBranchesForBitbucketApp: [
          {
            branchNamePatternBranchSelection: "example",
            genericOptionBranchSelection: "defaultBranch",
            events: [
              {
                type: "pullRequest",
                value: true
              }
            ]
          }
        ],
        scansEnabledForGitLabWebhooks: true,
        eventsTriggeringScansForBranchesForGitLabWebhooks: [
          {
            branchNamePatternBranchSelection: "example",
            genericOptionBranchSelection: "defaultBranch",
            events: [
              {
                type: "pullRequest",
                value: true
              }
            ]
          }
        ]
      }
    }
  })
})
.then(response => response.json())
.then(result => console.log(JSON.stringify(result, null, 2)))
.catch(error => console.error('Error:', error));

Python

import requests

query = 'mutation SetPipelineScanSettings($input: SetPipelineScanSettingsInput!) { setPipelineScanSettings(input: $input) { success } }'

response = requests.post(
  "https://api.cloud.ox.security/api/apollo-gateway",
  headers={
    "Content-Type": "application/json",
    "Authorization": "YOUR_API_TOKEN"
  },
  json={
    "query": query,
    # This is an example input showing all available input fields. Only fields marked as required in the schema are mandatory.
    "variables": {
      "input": {
        "appIds": ["30966426"],
        "timeout": 13.37,
        "performance": "example",
        "failOnTimeout": true,
        "failOnError": true,
        "scansEnabled": true,
        "scanSummaryAsCommentEnabled": true,
        "scanSummaryShowSuccess": true,
        "eventsTriggeringScansForBranches": [
          {
            "branchNamePatternBranchSelection": "example",
            "genericOptionBranchSelection": "defaultBranch",
            "events": [
              {
                "type": "pullRequest",
                "value": true
              }
            ]
          }
        ],
        "scansEnabledForBitbucketApp": true,
        "scanSummaryAsCommentEnabledForBitbucketApp": true,
        "eventsTriggeringScansForBranchesForBitbucketApp": [
          {
            "branchNamePatternBranchSelection": "example",
            "genericOptionBranchSelection": "defaultBranch",
            "events": [
              {
                "type": "pullRequest",
                "value": true
              }
            ]
          }
        ],
        "scansEnabledForGitLabWebhooks": true,
        "eventsTriggeringScansForBranchesForGitLabWebhooks": [
          {
            "branchNamePatternBranchSelection": "example",
            "genericOptionBranchSelection": "defaultBranch",
            "events": [
              {
                "type": "pullRequest",
                "value": true
              }
            ]
          }
        ]
      }
    }
  }
)

if response.status_code == 200:
    result = response.json()
    print(result)
else:
    print(f"Error: {response.status_code}")
    print(response.text)

Arguments

You can use the following argument(s) to customize your setPipelineScanSettings mutation.

Argument	Description	Supported fields
input SetPipelineScanSettingsInput! required		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

Return type: SetPipelineScanSettingsResponse!

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

Field	Description	Supported fields
success Boolean!	Whether all settings updates completed successfully.