Python SDK
from cognite.client.data_classes import TransformationJobStatus
res = client.transformations.run(id = 1, timeout = 60.0)
if res.status == TransformationJobStatus.RUNNING:
res.cancel()
Boolean jobResult1 =
client.transformations().jobs().cancel(10L);curl --request POST \
--url https://{cluster}.cognitedata.com/api/v1/projects/{project}/transformations/cancel \
--header 'Authorization: Bearer <token>' \
--header 'Content-Type: application/json' \
--data '
{
"externalId": "my.known.id"
}
'const options = {
method: 'POST',
headers: {Authorization: 'Bearer <token>', 'Content-Type': 'application/json'},
body: JSON.stringify({externalId: 'my.known.id'})
};
fetch('https://{cluster}.cognitedata.com/api/v1/projects/{project}/transformations/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://{cluster}.cognitedata.com/api/v1/projects/{project}/transformations/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([
'externalId' => 'my.known.id'
]),
CURLOPT_HTTPHEADER => [
"Authorization: Bearer <token>",
"Content-Type: application/json"
],
]);
$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://{cluster}.cognitedata.com/api/v1/projects/{project}/transformations/cancel"
payload := strings.NewReader("{\n \"externalId\": \"my.known.id\"\n}")
req, _ := http.NewRequest("POST", url, payload)
req.Header.Add("Authorization", "Bearer <token>")
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))
}require 'uri'
require 'net/http'
url = URI("https://{cluster}.cognitedata.com/api/v1/projects/{project}/transformations/cancel")
http = Net::HTTP.new(url.host, url.port)
http.use_ssl = true
request = Net::HTTP::Post.new(url)
request["Authorization"] = 'Bearer <token>'
request["Content-Type"] = 'application/json'
request.body = "{\n \"externalId\": \"my.known.id\"\n}"
response = http.request(request)
puts response.read_body{}{
"error": {
"code": 123,
"message": "<string>",
"missing": [
{
"externalId": "my.known.id"
}
],
"duplicated": [
{
"externalId": "my.known.id"
}
]
}
}{
"error": {
"code": 123,
"message": "<string>",
"missing": [
{
"externalId": "my.known.id"
}
],
"duplicated": [
{
"externalId": "my.known.id"
}
]
}
}Cancel a transformation
Required capabilities:
transformationsAcl:WRITE
POST
/
transformations
/
cancel
Python SDK
from cognite.client.data_classes import TransformationJobStatus
res = client.transformations.run(id = 1, timeout = 60.0)
if res.status == TransformationJobStatus.RUNNING:
res.cancel()
Boolean jobResult1 =
client.transformations().jobs().cancel(10L);curl --request POST \
--url https://{cluster}.cognitedata.com/api/v1/projects/{project}/transformations/cancel \
--header 'Authorization: Bearer <token>' \
--header 'Content-Type: application/json' \
--data '
{
"externalId": "my.known.id"
}
'const options = {
method: 'POST',
headers: {Authorization: 'Bearer <token>', 'Content-Type': 'application/json'},
body: JSON.stringify({externalId: 'my.known.id'})
};
fetch('https://{cluster}.cognitedata.com/api/v1/projects/{project}/transformations/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://{cluster}.cognitedata.com/api/v1/projects/{project}/transformations/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([
'externalId' => 'my.known.id'
]),
CURLOPT_HTTPHEADER => [
"Authorization: Bearer <token>",
"Content-Type: application/json"
],
]);
$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://{cluster}.cognitedata.com/api/v1/projects/{project}/transformations/cancel"
payload := strings.NewReader("{\n \"externalId\": \"my.known.id\"\n}")
req, _ := http.NewRequest("POST", url, payload)
req.Header.Add("Authorization", "Bearer <token>")
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))
}require 'uri'
require 'net/http'
url = URI("https://{cluster}.cognitedata.com/api/v1/projects/{project}/transformations/cancel")
http = Net::HTTP.new(url.host, url.port)
http.use_ssl = true
request = Net::HTTP::Post.new(url)
request["Authorization"] = 'Bearer <token>'
request["Content-Type"] = 'application/json'
request.body = "{\n \"externalId\": \"my.known.id\"\n}"
response = http.request(request)
puts response.read_body{}{
"error": {
"code": 123,
"message": "<string>",
"missing": [
{
"externalId": "my.known.id"
}
],
"duplicated": [
{
"externalId": "my.known.id"
}
]
}
}{
"error": {
"code": 123,
"message": "<string>",
"missing": [
{
"externalId": "my.known.id"
}
],
"duplicated": [
{
"externalId": "my.known.id"
}
]
}
}Authorizations
oidc-tokenoauth2-client-credentialsoauth2-open-industrial-dataoauth2-auth-code
Access token issued by the CDF project's configured identity provider. Access token must be an OpenID Connect token, and the project must be configured to accept OpenID Connect tokens. Use a header key of 'Authorization' with a value of 'Bearer $accesstoken'. The token can be obtained through any flow supported by the identity provider.
Body
application/json
- Option 1
- Option 2
The external ID provided by the client. Must be unique for the resource type.
Maximum string length:
255Example:
"my.known.id"
Response
Empty response.
The response is of type object.
Last modified on July 10, 2026
Was this page helpful?
⌘I