v1

latestOpenAPI 3.1.2Apache-2.02026-07-17241638.7 KB
Database

Query the CrawlDB

Executes a query against the Nutch CrawlDB. The type field in the request body determines the operation: stats, dump, topN, or url. The stats and url types return JSON; dump and topN return binary octet-stream data.

post/db/crawldb

Request body

confIdstring

Configuration ID. Falls back to "default" if not provided.

type'stats' | 'dump' | 'topN' | 'url' required

The type of CrawlDB query to execute.

argsobject

Additional arguments for the query.

crawlIdstring required

The crawl identifier.

Example request

{
  "confId": "default",
  "type": "stats",
  "crawlId": "crawl-01",
  "args": {}
}

Response

Query results. Content type varies by query type: application/json for stats and url queries; application/octet-stream for dump and topN queries.

object required

CrawlDB query result (returned for stats and url query types).