Skip to content

startCrawl

Start a crawl.

Arguments

Argument Type Description
name (required) String!
resources (required) [ResourceInput!]!
analyzerGroups (required) [AnalyzerGroupInput!]!
extWhiteList [String!]

Returns

StartCrawlReply!

Sample

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