Skip to content
QuantCDN

Run a crawler

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

Authorizations

Parameters

Path Parameters

organization
required
string

Organization identifier

Example
test-org
project
required
string

Project identifier

Example
test-project
crawler
required
string

Crawler identifier

Example
00000000-0000-0000-0000-000000000000

Request Body

object
urls

Optional URLs to crawl (overrides crawler’s default URL configuration). If not provided, the crawler will use its configured URLs or perform a full 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
{
  "message": "The requested resource was not found",
  "error": true
}

403

Access is forbidden.

object
message
required

Error message

string
The requested resource was not found
error
required

Error flag

boolean
true
{
  "message": "The requested resource was not found",
  "error": 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
{
  "message": "The requested resource was not found",
  "error": true
}

500

An unexpected error occurred.

object
message
required

Error message

string
The requested resource was not found
error
required

Error flag

boolean
true
{
  "message": "The requested resource was not found",
  "error": true
}