POST /v1/crawler

Add new URLs or update existing URLs for crawling and indexing.

Payload

{
  "action": "FETCH",
  "indexPublicKey": "SITEKEY",
  "url": "http://foo.com/bar.html"
}
FieldDescriptionTypeNotes
actionAdd new URLs or update existing URLs to crawl and indexstringAcceptable values: FETCH
indexPublicKeyThe public site keystringA sitekey is an identifier of your AddSearch account that can be found in the dashboard
urlThe document URLstringA full URL of your document including protocol (http/https), domain, and path. Example:
https://www.example.com/page.html

Response

{
  "message": "Scheduled",
  "docId": "doc id"
}
FieldDescriptionTypeNotes
messageInformation on recrawl statusstring
docIdThe Id generated for the documentstringURL encoded as md5 hash.

Indexing is executed within a minute from the API call.

Returns HTTP 202 ACCEPTED with payload e.g.

Please note that the Crawl API endpoint requires authentication. See authentication for more information.

Was this helpful?

Need more help?

We’re always happy to help with code or other questions you might have. Search our documentation, contact support, or connect with our sales team.