GuidesAPI Documentation
API Documentation
  1. 80legs API
  2. Crawls

Start a new crawl

put
https://{api_key}:@api.80legs.com/v2/crawls/

Start a new crawl named {crawl_name}

Recent Requests
Log in to see full request history
TimeStatusUser Agent
Retrieving recent requests…
LoadingLoading…

This queues a new crawl, using app to start crawling the urls in urllist. It begins with the status QUEUED.

This request can fail if:

  • max_depth and max_urls are out of bounds for the user's plan level
  • The specified app does not exist for this user
  • The specified urllist does not exist for this user
  • A crawl with this name already exists for this user
  • The user is already running the maximum number of crawls their plan allows

The crawl will be marked STARTED once it is automatically approved and work begins on it.

Path Params
string
required
Defaults to abcdefghijklmnopqrstuvwxyz012345

Replace this with your API key

string
required
Defaults to my_crawl1
Body Params
string

Name of the JavaScript 80app to use. Must belong to the given user.

string

Name of the url list to use. Must belong to the given user.

int32

The maximum depth to follow links on the crawl

int32

The maximum number of URLs to visit on this crawl

Headers
string
enum
Defaults to application/json

Generated from available response content types

Allowed:
Responses

Updated about 1 year ago

Language
Credentials
Basic
base64
:
URL
LoadingLoading…
Response
Click Try It! to start a request and see the response here! Or choose an example:
application/json
text/plain

Updated about 1 year ago