/api/v1/vikitron/crawl-start

Idempotently registers a domain as a crawl target and kicks off an immediate crawl. Will not start a second crawl while one is in progress and will not re-run a finished crawl.

vikitronpostApiV1VikitronCrawl-start

Parameters

1 body

1 total

Body · 1

domainstringRequired

Domain name (or subdomain) to crawl.

Length: 4–∞

Request

POST /api/v1/vikitron/crawl-start

post

curl -X POST "https://api.bizkithub.com/api/v1/vikitron/crawl-start" \
  -H "Content-Type: application/json" \
  -H "Authorization: Bearer YOUR_API_KEY" \
  -d '{
  "domain": "example.com"
}'

Response

Crawl start result.

{
  "domain": "example_domain",
  "domainId": "example_domainId",
  "inputHost": "example_inputHost",
  "redirected": false,
  "redirectChain": [
    {
      "from": "example_from",
      "to": "example_to",
      "httpCode": 0
    }
  ],
  "started": false,
  "message": "example_message",
  "counts": {
    "pending": 0,
    "running": 0,
    "ok": 0,
    "error": 0,
    "redirect": 0,
    "skipped": 0,
    "total": 0
  },
  "crawlBudget": 0
}

All response codes

1 status code documented

Need an API key?

All BizKitHub API endpoints require authentication via API key.

Get API Key