Cancel Crawl
curl --request DELETE \
--url https://sdk.nimbleway.com/v1/crawl/{id} \
--header 'Authorization: Bearer <token>'import requests
url = "https://sdk.nimbleway.com/v1/crawl/{id}"
headers = {"Authorization": "Bearer <token>"}
response = requests.delete(url, headers=headers)
print(response.text)const options = {method: 'DELETE', headers: {Authorization: 'Bearer <token>'}};
fetch('https://sdk.nimbleway.com/v1/crawl/{id}', options)
.then(res => res.json())
.then(res => console.log(res))
.catch(err => console.error(err));<?php
$curl = curl_init();
curl_setopt_array($curl, [
CURLOPT_URL => "https://sdk.nimbleway.com/v1/crawl/{id}",
CURLOPT_RETURNTRANSFER => true,
CURLOPT_ENCODING => "",
CURLOPT_MAXREDIRS => 10,
CURLOPT_TIMEOUT => 30,
CURLOPT_HTTP_VERSION => CURL_HTTP_VERSION_1_1,
CURLOPT_CUSTOMREQUEST => "DELETE",
CURLOPT_HTTPHEADER => [
"Authorization: Bearer <token>"
],
]);
$response = curl_exec($curl);
$err = curl_error($curl);
curl_close($curl);
if ($err) {
echo "cURL Error #:" . $err;
} else {
echo $response;
}package main
import (
"fmt"
"net/http"
"io"
)
func main() {
url := "https://sdk.nimbleway.com/v1/crawl/{id}"
req, _ := http.NewRequest("DELETE", url, nil)
req.Header.Add("Authorization", "Bearer <token>")
res, _ := http.DefaultClient.Do(req)
defer res.Body.Close()
body, _ := io.ReadAll(res.Body)
fmt.Println(string(body))
}HttpResponse<String> response = Unirest.delete("https://sdk.nimbleway.com/v1/crawl/{id}")
.header("Authorization", "Bearer <token>")
.asString();require 'uri'
require 'net/http'
url = URI("https://sdk.nimbleway.com/v1/crawl/{id}")
http = Net::HTTP.new(url.host, url.port)
http.use_ssl = true
request = Net::HTTP::Delete.new(url)
request["Authorization"] = 'Bearer <token>'
response = http.request(request)
puts response.read_body{
"status": "canceled"
}{
"status": "failed",
"msg": "Invalid request parameters",
"error": "PARAMETERS_FAILED_JSON_SCHEMA_VALIDATION_ERROR",
"details": {
"schema_validation_errors": [
{
"instancePath": "",
"schemaPath": "#/required",
"keyword": "required",
"params": {
"missingProperty": "search_engine"
},
"message": "must have required property 'search_engine'"
}
]
}
}{
"status": "failed",
"msg": "trial expired"
}{
"status": "failed",
"error": "Crawl not found"
}{
"status": "failed",
"msg": "Rate limit exceeded"
}{
"success": "false",
"task_id": "1ed1dbeb-8f34-4fd1-bb2d-a72bacae2ef3",
"message": "can't download the query response - please try again"
}Cancel Crawl
DELETE
/
v1
/
crawl
/
{id}
Cancel Crawl
curl --request DELETE \
--url https://sdk.nimbleway.com/v1/crawl/{id} \
--header 'Authorization: Bearer <token>'import requests
url = "https://sdk.nimbleway.com/v1/crawl/{id}"
headers = {"Authorization": "Bearer <token>"}
response = requests.delete(url, headers=headers)
print(response.text)const options = {method: 'DELETE', headers: {Authorization: 'Bearer <token>'}};
fetch('https://sdk.nimbleway.com/v1/crawl/{id}', options)
.then(res => res.json())
.then(res => console.log(res))
.catch(err => console.error(err));<?php
$curl = curl_init();
curl_setopt_array($curl, [
CURLOPT_URL => "https://sdk.nimbleway.com/v1/crawl/{id}",
CURLOPT_RETURNTRANSFER => true,
CURLOPT_ENCODING => "",
CURLOPT_MAXREDIRS => 10,
CURLOPT_TIMEOUT => 30,
CURLOPT_HTTP_VERSION => CURL_HTTP_VERSION_1_1,
CURLOPT_CUSTOMREQUEST => "DELETE",
CURLOPT_HTTPHEADER => [
"Authorization: Bearer <token>"
],
]);
$response = curl_exec($curl);
$err = curl_error($curl);
curl_close($curl);
if ($err) {
echo "cURL Error #:" . $err;
} else {
echo $response;
}package main
import (
"fmt"
"net/http"
"io"
)
func main() {
url := "https://sdk.nimbleway.com/v1/crawl/{id}"
req, _ := http.NewRequest("DELETE", url, nil)
req.Header.Add("Authorization", "Bearer <token>")
res, _ := http.DefaultClient.Do(req)
defer res.Body.Close()
body, _ := io.ReadAll(res.Body)
fmt.Println(string(body))
}HttpResponse<String> response = Unirest.delete("https://sdk.nimbleway.com/v1/crawl/{id}")
.header("Authorization", "Bearer <token>")
.asString();require 'uri'
require 'net/http'
url = URI("https://sdk.nimbleway.com/v1/crawl/{id}")
http = Net::HTTP.new(url.host, url.port)
http.use_ssl = true
request = Net::HTTP::Delete.new(url)
request["Authorization"] = 'Bearer <token>'
response = http.request(request)
puts response.read_body{
"status": "canceled"
}{
"status": "failed",
"msg": "Invalid request parameters",
"error": "PARAMETERS_FAILED_JSON_SCHEMA_VALIDATION_ERROR",
"details": {
"schema_validation_errors": [
{
"instancePath": "",
"schemaPath": "#/required",
"keyword": "required",
"params": {
"missingProperty": "search_engine"
},
"message": "must have required property 'search_engine'"
}
]
}
}{
"status": "failed",
"msg": "trial expired"
}{
"status": "failed",
"error": "Crawl not found"
}{
"status": "failed",
"msg": "Rate limit exceeded"
}{
"success": "false",
"task_id": "1ed1dbeb-8f34-4fd1-bb2d-a72bacae2ef3",
"message": "can't download the query response - please try again"
}Authorizations
Bearer authentication header of the form Bearer <token>, where <token> is your auth token.
Path Parameters
The unique identifier of the crawl task
Example:
"123e4567-e89b-12d3-a456-426614174000"
Response
Successful Response
Available options:
canceled Was this page helpful?
⌘I