Skip to content

startCrawl

Endpoints for ODC Start a crawl.

Arguments

Argument Type Description
name (required) String! Name of the crawl.
resources (required) [ResourceInput!]! Resources to include in the crawl.
analyzerGroups [AnalyzerGroupInput!] Analyzer groups to run during the crawl. Mutually exclusive with dataCategoryIds: exactly one of the two must be supplied.
extWhiteList [String!] External whitelist entries for the crawl.
dataCategoryIds [String!] Data category IDs to scan. Mutually exclusive with analyzerGroups.

Returns

StartCrawlReply!

Sample

mutation StartCrawl($name: String!, $resources: [ResourceInput!]!) {
  startCrawl(
    name: $name
    resources: $resources
  ) {
    crawlId
  }
}
{
  "name": "example-string",
  "resources": [
    {}
  ]
}
{
  "data": {
    "startCrawl": {
      "crawlId": "example-string"
    }
  }
}