cURL
curl --request POST \
--url https://api.nekt.ai/api/v1/runs/{id}/cancel/ \
--header 'Content-Type: application/json' \
--header 'x-api-key: <api-key>' \
--data '{}'import requests
url = "https://api.nekt.ai/api/v1/runs/{id}/cancel/"
payload = {}
headers = {
"x-api-key": "<api-key>",
"Content-Type": "application/json"
}
response = requests.post(url, json=payload, headers=headers)
print(response.text)const options = {
method: 'POST',
headers: {'x-api-key': '<api-key>', 'Content-Type': 'application/json'},
body: JSON.stringify({})
};
fetch('https://api.nekt.ai/api/v1/runs/{id}/cancel/', 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://api.nekt.ai/api/v1/runs/{id}/cancel/",
CURLOPT_RETURNTRANSFER => true,
CURLOPT_ENCODING => "",
CURLOPT_MAXREDIRS => 10,
CURLOPT_TIMEOUT => 30,
CURLOPT_HTTP_VERSION => CURL_HTTP_VERSION_1_1,
CURLOPT_CUSTOMREQUEST => "POST",
CURLOPT_POSTFIELDS => json_encode([
]),
CURLOPT_HTTPHEADER => [
"Content-Type: application/json",
"x-api-key: <api-key>"
],
]);
$response = curl_exec($curl);
$err = curl_error($curl);
curl_close($curl);
if ($err) {
echo "cURL Error #:" . $err;
} else {
echo $response;
}package main
import (
"fmt"
"strings"
"net/http"
"io"
)
func main() {
url := "https://api.nekt.ai/api/v1/runs/{id}/cancel/"
payload := strings.NewReader("{}")
req, _ := http.NewRequest("POST", url, payload)
req.Header.Add("x-api-key", "<api-key>")
req.Header.Add("Content-Type", "application/json")
res, _ := http.DefaultClient.Do(req)
defer res.Body.Close()
body, _ := io.ReadAll(res.Body)
fmt.Println(string(body))
}HttpResponse<String> response = Unirest.post("https://api.nekt.ai/api/v1/runs/{id}/cancel/")
.header("x-api-key", "<api-key>")
.header("Content-Type", "application/json")
.body("{}")
.asString();require 'uri'
require 'net/http'
url = URI("https://api.nekt.ai/api/v1/runs/{id}/cancel/")
http = Net::HTTP.new(url.host, url.port)
http.use_ssl = true
request = Net::HTTP::Post.new(url)
request["x-api-key"] = '<api-key>'
request["Content-Type"] = 'application/json'
request.body = "{}"
response = http.request(request)
puts response.read_body{
"id": "3c90c3cc-0d44-4b50-8888-8dd25736052a",
"number": 123,
"created_at": "2023-11-07T05:31:56Z",
"updated_at": "2023-11-07T05:31:56Z",
"started_at": "2023-11-07T05:31:56Z",
"ended_at": "2023-11-07T05:31:56Z",
"duration_seconds": 123,
"status": "pending_events",
"trigger": {
"type": "<string>",
"cron_expression": "<string>",
"cron_timezone": "<string>",
"event_rule": "<string>"
},
"full_sync": true,
"extra_config": null,
"credit_charge_status": "unsuccessful",
"el_cost_usd": 123,
"el_cost_metadata": null,
"transformation_cost_usd": 123,
"transformation_cost_metadata": null,
"cancel_requested_at": "2023-11-07T05:31:56Z",
"triggered_by": 123,
"triggered_by_token": "<string>",
"cancel_requested_by": 123,
"cancel_requested_by_token": "<string>",
"source": "<string>",
"destination": "<string>",
"transformation": "<string>"
}Runs
Cancel Run
POST
/
api
/
v1
/
runs
/
{id}
/
cancel
/
cURL
curl --request POST \
--url https://api.nekt.ai/api/v1/runs/{id}/cancel/ \
--header 'Content-Type: application/json' \
--header 'x-api-key: <api-key>' \
--data '{}'import requests
url = "https://api.nekt.ai/api/v1/runs/{id}/cancel/"
payload = {}
headers = {
"x-api-key": "<api-key>",
"Content-Type": "application/json"
}
response = requests.post(url, json=payload, headers=headers)
print(response.text)const options = {
method: 'POST',
headers: {'x-api-key': '<api-key>', 'Content-Type': 'application/json'},
body: JSON.stringify({})
};
fetch('https://api.nekt.ai/api/v1/runs/{id}/cancel/', 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://api.nekt.ai/api/v1/runs/{id}/cancel/",
CURLOPT_RETURNTRANSFER => true,
CURLOPT_ENCODING => "",
CURLOPT_MAXREDIRS => 10,
CURLOPT_TIMEOUT => 30,
CURLOPT_HTTP_VERSION => CURL_HTTP_VERSION_1_1,
CURLOPT_CUSTOMREQUEST => "POST",
CURLOPT_POSTFIELDS => json_encode([
]),
CURLOPT_HTTPHEADER => [
"Content-Type: application/json",
"x-api-key: <api-key>"
],
]);
$response = curl_exec($curl);
$err = curl_error($curl);
curl_close($curl);
if ($err) {
echo "cURL Error #:" . $err;
} else {
echo $response;
}package main
import (
"fmt"
"strings"
"net/http"
"io"
)
func main() {
url := "https://api.nekt.ai/api/v1/runs/{id}/cancel/"
payload := strings.NewReader("{}")
req, _ := http.NewRequest("POST", url, payload)
req.Header.Add("x-api-key", "<api-key>")
req.Header.Add("Content-Type", "application/json")
res, _ := http.DefaultClient.Do(req)
defer res.Body.Close()
body, _ := io.ReadAll(res.Body)
fmt.Println(string(body))
}HttpResponse<String> response = Unirest.post("https://api.nekt.ai/api/v1/runs/{id}/cancel/")
.header("x-api-key", "<api-key>")
.header("Content-Type", "application/json")
.body("{}")
.asString();require 'uri'
require 'net/http'
url = URI("https://api.nekt.ai/api/v1/runs/{id}/cancel/")
http = Net::HTTP.new(url.host, url.port)
http.use_ssl = true
request = Net::HTTP::Post.new(url)
request["x-api-key"] = '<api-key>'
request["Content-Type"] = 'application/json'
request.body = "{}"
response = http.request(request)
puts response.read_body{
"id": "3c90c3cc-0d44-4b50-8888-8dd25736052a",
"number": 123,
"created_at": "2023-11-07T05:31:56Z",
"updated_at": "2023-11-07T05:31:56Z",
"started_at": "2023-11-07T05:31:56Z",
"ended_at": "2023-11-07T05:31:56Z",
"duration_seconds": 123,
"status": "pending_events",
"trigger": {
"type": "<string>",
"cron_expression": "<string>",
"cron_timezone": "<string>",
"event_rule": "<string>"
},
"full_sync": true,
"extra_config": null,
"credit_charge_status": "unsuccessful",
"el_cost_usd": 123,
"el_cost_metadata": null,
"transformation_cost_usd": 123,
"transformation_cost_metadata": null,
"cancel_requested_at": "2023-11-07T05:31:56Z",
"triggered_by": 123,
"triggered_by_token": "<string>",
"cancel_requested_by": 123,
"cancel_requested_by_token": "<string>",
"source": "<string>",
"destination": "<string>",
"transformation": "<string>"
}Authorizations
API Key authentication. Format: 'x-api-key: api_key'
Path Parameters
A UUID string identifying this Pipeline run.
Body
application/jsonapplication/x-www-form-urlencodedmultipart/form-data
The body is of type object.
Response
200 - application/json
pending_events- PENDING_EVENTSqueued- QUEUEDrunning- RUNNINGsuccess- SUCCESSfailed- FAILEDcancelling- CANCELLINGcanceled- CANCELED
Available options:
pending_events, queued, running, success, failed, cancelling, canceled Show child attributes
Show child attributes
unsuccessful- Unsuccessfulcharged- Charged
Available options:
unsuccessful, charged User that triggered the run (Expandable)
API token that triggered the run (Expandable)
User that requested the cancellation of the run (Expandable)
API token that requested the cancellation of the run (Expandable)
Source of the run (Expandable)
Destination of the run (Expandable)
Transformation of the run (Expandable)
Was this page helpful?