Skip to content
Utilerio
All endpoints

Broken Link Checker

GET/api/v1/net/broken-link-check

Crawl a site from a starting URL and find every link that returns an error or fails to load.

Authentication

Requires an API key in the X-API-Key header.

Try it

GET/api/v1/net/broken-link-check

Parameters

urlstringrequired

Start URL to crawl from.

maxDepthintegeroptional

Link-hops to follow, 1–3. Default 2.

maxPagesintegeroptional

Pages to crawl, 1–20. Default 10.

sameDomainOnlybooleanoptional

Only crawl links on the start page's own domain. Default true.

Request body

{
  "url": "https://example.com",
  "maxDepth": 2,
  "maxPages": 10
}

Response codes

  • 200Success.
  • 400Invalid request — check your body or parameters.
  • 401Missing or invalid API key.
  • 403The API key is not scoped to this endpoint.
  • 429Rate limit exceeded — retry after a short wait.

Language

cURL

Request

curl -X POST https://utilerio.com/api/v1/net/broken-link-check \
  -H "X-API-Key: YOUR_KEY" \
  -H "Content-Type: application/json" \
  -d '{"url":"https://example.com","maxDepth":2,"maxPages":10}'

Response

{ "startUrl": "https://example.com", "pagesCrawled": 3, "linksChecked": 42, "brokenLinks": [], "truncated": false }