Skip to main content
POST
/
crawl
/
{id}
/
crawl
Start a new crawl
curl --request POST \
  --url https://api.open.cx/crawl/{id}/crawl
{
  "id": "3c90c3cc-0d44-4b50-8888-8dd25736052a",
  "datasource_id": "3c90c3cc-0d44-4b50-8888-8dd25736052a",
  "status": "<string>",
  "started_at": "2023-11-07T05:31:56Z",
  "completed_at": "2023-11-07T05:31:56Z",
  "total_pages": 123,
  "completed_pages": 123,
  "new_pages": 123,
  "updated_pages": 123,
  "removed_pages": 123,
  "unchanged_pages": 123,
  "error_message": "<string>",
  "created_at": "2023-11-07T05:31:56Z",
  "updated_at": "2023-11-07T05:31:56Z"
}

Path Parameters

​
id
string<uuid>
required

The website datasource ID

Response

Default Response

​
id
string<uuid>
required
​
datasource_id
string<uuid>
required
​
status
string
required
​
started_at
string<date-time> | null
required
​
completed_at
string<date-time> | null
required
​
total_pages
number | null
required
​
completed_pages
number
required
​
new_pages
number
required
​
updated_pages
number
required
​
removed_pages
number
required
​
unchanged_pages
number
required
​
error_message
string | null
required
​
created_at
string<date-time>
required
​
updated_at
string<date-time>
required