Skip to content

Run a crawler

POST
/api/v2/organizations/{organization}/projects/{project}/crawlers/{crawler}/run

Authorizations

Parameters

Path Parameters

organization
required
string

Organization identifier

project
required
string

Project identifier

crawler
required
string

Crawler identifier

Request Body required

object
urls

URLs to crawl

Array<string>
[
"/",
"/about",
"/contact"
]

Responses

200

The request has succeeded.

object
run_id

The crawler run ID

string
12345

400

The server could not understand the request due to invalid syntax.

object
message
required

Error message

string
The requested resource was not found
error
required

Error flag

boolean
true

403

Access is forbidden.

object
message
required

Error message

string
The requested resource was not found
error
required

Error flag

boolean
true

404

The resource was not found.

object
message
required

Error message

string
The requested resource was not found
error
required

Error flag

boolean
true

500

An unexpected error occurred.

object
message
required

Error message

string
The requested resource was not found
error
required

Error flag

boolean
true