Skip to main content
POST
Start a website crawl
Requires web:crawl through a scoped Pirehub API key or OAuth token. See Web data for request limits, response fields, crawl lifecycle and error handling. See Authentication for credential headers and quota rules.

Authorizations

Authorization
string
header
required

OAuth 2.0 Authorization Code with PKCE, issued by Pirehub's Clerk authorization server. Request only the scopes required by the operation.

Body

application/json
requestId
string<uuid>
required

Unique UUID for an intentional crawl. Reuse by the same credential returns 409 for 24 hours, including after ambiguous upstream failures.

url
string<uri>
required

Public HTTP(S) URL without credentials, using port 80 or 443; checked against private addresses and DNS.

Maximum string length: 2048
limit
integer
default:10
Required range: 1 <= x <= 20
maxDepth
integer
default:1
Required range: 1 <= x <= 3

Response

Successful operation.

success
any
required
data
object
required