Run a crawler

POST

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

const url = 'https://dashboard.quantcdn.io/api/v2/organizations/test-org/projects/test-project/crawlers/00000000-0000-0000-0000-000000000000/run';
const options = {
  method: 'POST',
  headers: {Authorization: 'Bearer <token>', 'Content-Type': 'application/json'},
  body: '{"urls":["/","/about","/contact"]}'
};

try {
  const response = await fetch(url, options);
  const data = await response.json();
  console.log(data);
} catch (error) {
  console.error(error);
}

curl --request POST \
  --url https://dashboard.quantcdn.io/api/v2/organizations/test-org/projects/test-project/crawlers/00000000-0000-0000-0000-000000000000/run \
  --header 'Authorization: Bearer <token>' \
  --header 'Content-Type: application/json' \
  --data '{ "urls": [ "/", "/about", "/contact" ] }'

Authorizations

BearerAuth

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

application/json

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>

Example

[
  "/",
  "/about",
  "/contact"
]

Responses

200

The request has succeeded.

application/json

object

run_id

The crawler run ID

string

Example

{
  "run_id": "12345"
}

400

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

application/json

object

message

required

Error message

string

error

required

Error flag

boolean

Example

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

403

Access is forbidden.

application/json

object

message

required

Error message

string

error

required

Error flag

boolean

Example

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

404

The resource was not found.

application/json

object

message

required

Error message

string

error

required

Error flag

boolean

Example

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

500

An unexpected error occurred.

application/json

object

message

required

Error message

string

error

required

Error flag

boolean

Example

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