scanAll

Trigger a scan of all configured connectors.

Examples

mutation ScanAll($isFullScan: Boolean, $isContainerFullScan: Boolean, $isExternalToolFullScan: Boolean, $useCustomScannerTag: Boolean, $dastScanConfig: TriggerDastScanInput) {
  scanAll(isFullScan: $isFullScan, isContainerFullScan: $isContainerFullScan, isExternalToolFullScan: $isExternalToolFullScan, useCustomScannerTag: $useCustomScannerTag, dastScanConfig: $dastScanConfig) {
    scanID
    isFullScan
    isContainerFullScan
    isSingleRepoScan
    isDastFullScan
    isDastOnlyScan
    scannerTag
  }
}

Variables

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

{
  "isFullScan": true,
  "isContainerFullScan": true,
  "isExternalToolFullScan": true,
  "useCustomScannerTag": true,
  "dastScanConfig": {
    "targets": [
      {
        "targetId": "example",
        "subtargets": ["example"],
        "categories": ["example"]
      }
    ]
  }
}

curl -X POST \
https://api.cloud.ox.security/api/apollo-gateway \
-H 'Content-Type: application/json' \
-H 'Authorization: YOUR_API_TOKEN' \
-d '{
 "query": "mutation ScanAll($isFullScan: Boolean, $isContainerFullScan: Boolean, $isExternalToolFullScan: Boolean, $useCustomScannerTag: Boolean, $dastScanConfig: TriggerDastScanInput) { scanAll(isFullScan: $isFullScan, isContainerFullScan: $isContainerFullScan, isExternalToolFullScan: $isExternalToolFullScan, useCustomScannerTag: $useCustomScannerTag, dastScanConfig: $dastScanConfig) { scanID isFullScan isContainerFullScan isSingleRepoScan isDastFullScan isDastOnlyScan scannerTag } }",
 "variables": {
    "isFullScan": true,
    "isContainerFullScan": true,
    "isExternalToolFullScan": true,
    "useCustomScannerTag": true,
    "dastScanConfig": {
      "targets": [
        {
          "targetId": "example",
          "subtargets": ["example"],
          "categories": ["example"]
        }
      ]
    }
  }
}'

const query = 'mutation ScanAll($isFullScan: Boolean, $isContainerFullScan: Boolean, $isExternalToolFullScan: Boolean, $useCustomScannerTag: Boolean, $dastScanConfig: TriggerDastScanInput) { scanAll(isFullScan: $isFullScan, isContainerFullScan: $isContainerFullScan, isExternalToolFullScan: $isExternalToolFullScan, useCustomScannerTag: $useCustomScannerTag, dastScanConfig: $dastScanConfig) { scanID isFullScan isContainerFullScan isSingleRepoScan isDastFullScan isDastOnlyScan scannerTag } }';

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: {
      isFullScan: true,
      isContainerFullScan: true,
      isExternalToolFullScan: true,
      useCustomScannerTag: true,
      dastScanConfig: {
        targets: [
          {
            targetId: "example",
            subtargets: ["example"],
            categories: ["example"]
          }
        ]
      }
    }
  })
})
.then(response => response.json())
.then(result => console.log(JSON.stringify(result, null, 2)))
.catch(error => console.error('Error:', error));

import requests

query = 'mutation ScanAll($isFullScan: Boolean, $isContainerFullScan: Boolean, $isExternalToolFullScan: Boolean, $useCustomScannerTag: Boolean, $dastScanConfig: TriggerDastScanInput) { scanAll(isFullScan: $isFullScan, isContainerFullScan: $isContainerFullScan, isExternalToolFullScan: $isExternalToolFullScan, useCustomScannerTag: $useCustomScannerTag, dastScanConfig: $dastScanConfig) { scanID isFullScan isContainerFullScan isSingleRepoScan isDastFullScan isDastOnlyScan scannerTag } }'

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": {
      "isFullScan": true,
      "isContainerFullScan": true,
      "isExternalToolFullScan": true,
      "useCustomScannerTag": true,
      "dastScanConfig": {
        "targets": [
          {
            "targetId": "example",
            "subtargets": ["example"],
            "categories": ["example"]
          }
        ]
      }
    }
  }
)

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 scanAll mutation.

Argument

Description

Supported fields

isFullScan Boolean

isContainerFullScan Boolean

isExternalToolFullScan Boolean

useCustomScannerTag Boolean

dastScanConfig TriggerDastScanInput

targets [DastScanConfigTargetInput!]

Fields

Return type: ScanResponse

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

Field

Description

Supported fields

scanID String

Unique identifier for tracking the scan progress

isFullScan Boolean

Indicates if this is a full code scan rather than an incremental scan

isContainerFullScan Boolean

Indicates if this is a full container scan rather than an incremental scan

isSingleRepoScan Boolean

Indicates if this is a scan of a single repository

isDastFullScan Boolean

Indicates if this is a full DAST scan rather than an incremental scan

isDastOnlyScan Boolean

Indicates if this is a DAST-only scan

scannerTag String

Scanner image tag

Last updated 3 days ago