singleRepoScan

Trigger a scan for specific repositories.

Examples

GraphQL

mutation SingleRepoScan($singleRepoScanInput: SingleRepoScanInput) {
  singleRepoScan(singleRepoScanInput: $singleRepoScanInput) {
    scanID
    isFullScan
    isContainerFullScan
    isSingleRepoScan
    isDastFullScan
    isDastOnlyScan
    scannerTag
    isCspmScopedScan
    alreadyRunning
    runningScanType
  }
}

Variables

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

{
  "singleRepoScanInput": {
    "applications": [
      {
        "appId": "30966426",
        "appName": "My Application",
        "connectorId": "2",
        "credentialsId": "example"
      }
    ]
  }
}

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 SingleRepoScan($singleRepoScanInput: SingleRepoScanInput) { singleRepoScan(singleRepoScanInput: $singleRepoScanInput) { scanID isFullScan isContainerFullScan isSingleRepoScan isDastFullScan isDastOnlyScan scannerTag isCspmScopedScan alreadyRunning runningScanType } }",
 "variables": {
    "singleRepoScanInput": {
      "applications": [
        {
          "appId": "30966426",
          "appName": "My Application",
          "connectorId": "2",
          "credentialsId": "example"
        }
      ]
    }
  }
}'

Node.js

const query = 'mutation SingleRepoScan($singleRepoScanInput: SingleRepoScanInput) { singleRepoScan(singleRepoScanInput: $singleRepoScanInput) { scanID isFullScan isContainerFullScan isSingleRepoScan isDastFullScan isDastOnlyScan scannerTag isCspmScopedScan alreadyRunning runningScanType } }';

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: {
      singleRepoScanInput: {
        applications: [
          {
            appId: "30966426",
            appName: "My Application",
            connectorId: "2",
            credentialsId: "example"
          }
        ]
      }
    }
  })
})
.then(response => response.json())
.then(result => console.log(JSON.stringify(result, null, 2)))
.catch(error => console.error('Error:', error));

Python

import requests

query = 'mutation SingleRepoScan($singleRepoScanInput: SingleRepoScanInput) { singleRepoScan(singleRepoScanInput: $singleRepoScanInput) { scanID isFullScan isContainerFullScan isSingleRepoScan isDastFullScan isDastOnlyScan scannerTag isCspmScopedScan alreadyRunning runningScanType } }'

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": {
      "singleRepoScanInput": {
        "applications": [
          {
            "appId": "30966426",
            "appName": "My Application",
            "connectorId": "2",
            "credentialsId": "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 singleRepoScan mutation.

Argument	Description	Supported fields
singleRepoScanInput SingleRepoScanInput		applications [ApplicationToScanInput]!

Fields

Return type: ScanResponse

You can use the following field(s) to specify what information your singleRepoScan 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
isCspmScopedScan Boolean	Indicates if this is an on-demand rescan of a single cloud asset
alreadyRunning Boolean	True when another scan was already running, so nothing new was queued; scanID is that running scan
runningScanType String	Kind of the already-running scan: regular, singleRepo, dastOnly or cspmRescan