---
title: "Manage a Crawl Job"
method: GET
path: "/crawl"
---

# Manage a Crawl Job

`GET /crawl`

Pause, delete, restart, or view the status of a crawl job.

## Query parameters

- `token` string, required
- `name` string
- `roundStart` string
- `pause` string
- `restart` string
- `delete` string

## Response `200`

200

- union
  - object
    - `response` string
    - `jobs` object[]
      - `jobStatus` object
        - `message` string
        - `status` integer
      - `maxHops` integer
      - `downloadJson` string
      - `urlProcessPattern` string
      - `jobCompletionTimeUTC` integer
      - `maxRounds` integer
      - `type` string
      - `pageCrawlSuccessesThisRound` integer
      - `urlCrawlRegEx` string
      - `pageProcessPattern` string
      - `apiUrl` string
      - `useCanonical` integer
      - `jobCreationTimeUTC` integer
      - `repeat` integer
      - `downloadUrls` string
      - `obeyRobots` integer
      - `roundsCompleted` integer
      - `pageCrawlAttempts` integer
      - `notifyWebhook` string
      - `pageProcessSuccessesThisRound` integer
      - `customHeaders` object
      - `objectsFound` integer
      - `roundStartTime` integer
      - `urlCrawlPattern` string
      - `seedRecrawlFrequency` integer
      - `urlProcessRegEx` string
      - `pageProcessSuccesses` integer
      - `urlsHarvested` integer
      - `crawlDelay` integer
      - `currentTime` integer
      - `useProxies` integer
      - `sentJobDoneNotification` integer
      - `currentTimeUTC` integer
      - `name` string
      - `notifyEmail` string
      - `pageCrawlSuccesses` integer
      - `pageProcessAttempts` integer
  - object
    - `response` string
    - `jobs` object[]
      - `jobStatus` object
        - `message` string
        - `status` integer
      - `maxHops` integer
      - `downloadJson` string
      - `urlProcessPattern` string
      - `jobCompletionTimeUTC` integer
      - `maxRounds` integer
      - `type` string
      - `pageCrawlSuccessesThisRound` integer
      - `urlCrawlRegEx` string
      - `pageProcessPattern` string
      - `apiUrl` string
      - `useCanonical` integer
      - `jobCreationTimeUTC` integer
      - `repeat` integer
      - `downloadUrls` string
      - `obeyRobots` integer
      - `roundsCompleted` integer
      - `pageCrawlAttempts` integer
      - `notifyWebhook` string
      - `pageProcessSuccessesThisRound` integer
      - `customHeaders` object
      - `objectsFound` integer
      - `roundStartTime` integer
      - `urlCrawlPattern` string
      - `seedRecrawlFrequency` integer
      - `urlProcessRegEx` string
      - `pageProcessSuccesses` integer
      - `urlsHarvested` integer
      - `crawlDelay` integer
      - `currentTime` integer
      - `useProxies` integer
      - `sentJobDoneNotification` integer
      - `currentTimeUTC` integer
      - `name` string
      - `notifyEmail` string
      - `pageCrawlSuccesses` integer
      - `pageProcessAttempts` integer
  - object
    - `response` string
  - object
    - `jobs` object[]
      - `jobStatus` object
        - `message` string
        - `status` integer
      - `maxHops` integer
      - `downloadJson` string
      - `urlProcessPattern` string
      - `jobCompletionTimeUTC` integer
      - `maxRounds` integer
      - `type` string
      - `pageCrawlSuccessesThisRound` integer
      - `urlCrawlRegEx` string
      - `pageProcessPattern` string
      - `apiUrl` string
      - `useCanonical` integer
      - `jobCreationTimeUTC` integer
      - `repeat` integer
      - `downloadUrls` string
      - `obeyRobots` integer
      - `roundsCompleted` integer
      - `pageCrawlAttempts` integer
      - `notifyWebhook` string
      - `pageProcessSuccessesThisRound` integer
      - `customHeaders` object
      - `objectsFound` integer
      - `roundStartTime` integer
      - `urlCrawlPattern` string
      - `seedRecrawlFrequency` integer
      - `urlProcessRegEx` string
      - `pageProcessSuccesses` integer
      - `urlsHarvested` integer
      - `crawlDelay` integer
      - `currentTime` integer
      - `useProxies` integer
      - `sentJobDoneNotification` integer
      - `currentTimeUTC` integer
      - `name` string
      - `notifyEmail` string
      - `pageCrawlSuccesses` integer
      - `pageProcessAttempts` integer

## Other responses

- `500` — 500

---

[API](https://skmtc.net/diffbot/apis/web-search.md) · [All operations](https://skmtc.net/diffbot/apis/web-search/llms.txt) · [OpenAPI document](https://skmtc-service-staging.skmtc.workers.dev/v1/apis/diffbot/web-search/versions/8b88d7dabe63/schema)