Update threat detection config
curl --request POST \
--url https://app.chainpatrol.io/api/v2/detection/configs/update \
--header 'Content-Type: application/json' \
--header 'X-API-KEY: <api-key>' \
--data '
{
"slug": "<string>",
"configId": 1,
"title": "<string>",
"description": "<string>",
"cron": "<string>",
"config": {},
"mergeConfig": false,
"brandId": 1
}
'import requests
url = "https://app.chainpatrol.io/api/v2/detection/configs/update"
payload = {
"slug": "<string>",
"configId": 1,
"title": "<string>",
"description": "<string>",
"cron": "<string>",
"config": {},
"mergeConfig": False,
"brandId": 1
}
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({
slug: '<string>',
configId: 1,
title: '<string>',
description: '<string>',
cron: '<string>',
config: {},
mergeConfig: false,
brandId: 1
})
};
fetch('https://app.chainpatrol.io/api/v2/detection/configs/update', 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://app.chainpatrol.io/api/v2/detection/configs/update",
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([
'slug' => '<string>',
'configId' => 1,
'title' => '<string>',
'description' => '<string>',
'cron' => '<string>',
'config' => [
],
'mergeConfig' => false,
'brandId' => 1
]),
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://app.chainpatrol.io/api/v2/detection/configs/update"
payload := strings.NewReader("{\n \"slug\": \"<string>\",\n \"configId\": 1,\n \"title\": \"<string>\",\n \"description\": \"<string>\",\n \"cron\": \"<string>\",\n \"config\": {},\n \"mergeConfig\": false,\n \"brandId\": 1\n}")
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://app.chainpatrol.io/api/v2/detection/configs/update")
.header("X-API-KEY", "<api-key>")
.header("Content-Type", "application/json")
.body("{\n \"slug\": \"<string>\",\n \"configId\": 1,\n \"title\": \"<string>\",\n \"description\": \"<string>\",\n \"cron\": \"<string>\",\n \"config\": {},\n \"mergeConfig\": false,\n \"brandId\": 1\n}")
.asString();require 'uri'
require 'net/http'
url = URI("https://app.chainpatrol.io/api/v2/detection/configs/update")
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 = "{\n \"slug\": \"<string>\",\n \"configId\": 1,\n \"title\": \"<string>\",\n \"description\": \"<string>\",\n \"cron\": \"<string>\",\n \"config\": {},\n \"mergeConfig\": false,\n \"brandId\": 1\n}"
response = http.request(request)
puts response.read_body{
"config": {
"id": 123,
"source": "<string>",
"title": "<string>",
"description": "<string>",
"cron": "<string>",
"config": {},
"updatedAt": "<string>",
"brandId": 123
}
}{
"code": "BAD_REQUEST",
"message": "Invalid input data",
"issues": []
}{
"code": "UNAUTHORIZED",
"message": "Authorization not provided",
"issues": []
}{
"code": "FORBIDDEN",
"message": "Insufficient access",
"issues": []
}{
"code": "INTERNAL_SERVER_ERROR",
"message": "Internal server error",
"issues": []
}Threats
Update Detection Config
Update an organization threat detection config status, schedule, and config fields.
POST
/
detection
/
configs
/
update
Update threat detection config
curl --request POST \
--url https://app.chainpatrol.io/api/v2/detection/configs/update \
--header 'Content-Type: application/json' \
--header 'X-API-KEY: <api-key>' \
--data '
{
"slug": "<string>",
"configId": 1,
"title": "<string>",
"description": "<string>",
"cron": "<string>",
"config": {},
"mergeConfig": false,
"brandId": 1
}
'import requests
url = "https://app.chainpatrol.io/api/v2/detection/configs/update"
payload = {
"slug": "<string>",
"configId": 1,
"title": "<string>",
"description": "<string>",
"cron": "<string>",
"config": {},
"mergeConfig": False,
"brandId": 1
}
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({
slug: '<string>',
configId: 1,
title: '<string>',
description: '<string>',
cron: '<string>',
config: {},
mergeConfig: false,
brandId: 1
})
};
fetch('https://app.chainpatrol.io/api/v2/detection/configs/update', 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://app.chainpatrol.io/api/v2/detection/configs/update",
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([
'slug' => '<string>',
'configId' => 1,
'title' => '<string>',
'description' => '<string>',
'cron' => '<string>',
'config' => [
],
'mergeConfig' => false,
'brandId' => 1
]),
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://app.chainpatrol.io/api/v2/detection/configs/update"
payload := strings.NewReader("{\n \"slug\": \"<string>\",\n \"configId\": 1,\n \"title\": \"<string>\",\n \"description\": \"<string>\",\n \"cron\": \"<string>\",\n \"config\": {},\n \"mergeConfig\": false,\n \"brandId\": 1\n}")
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://app.chainpatrol.io/api/v2/detection/configs/update")
.header("X-API-KEY", "<api-key>")
.header("Content-Type", "application/json")
.body("{\n \"slug\": \"<string>\",\n \"configId\": 1,\n \"title\": \"<string>\",\n \"description\": \"<string>\",\n \"cron\": \"<string>\",\n \"config\": {},\n \"mergeConfig\": false,\n \"brandId\": 1\n}")
.asString();require 'uri'
require 'net/http'
url = URI("https://app.chainpatrol.io/api/v2/detection/configs/update")
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 = "{\n \"slug\": \"<string>\",\n \"configId\": 1,\n \"title\": \"<string>\",\n \"description\": \"<string>\",\n \"cron\": \"<string>\",\n \"config\": {},\n \"mergeConfig\": false,\n \"brandId\": 1\n}"
response = http.request(request)
puts response.read_body{
"config": {
"id": 123,
"source": "<string>",
"title": "<string>",
"description": "<string>",
"cron": "<string>",
"config": {},
"updatedAt": "<string>",
"brandId": 123
}
}{
"code": "BAD_REQUEST",
"message": "Invalid input data",
"issues": []
}{
"code": "UNAUTHORIZED",
"message": "Authorization not provided",
"issues": []
}{
"code": "FORBIDDEN",
"message": "Insufficient access",
"issues": []
}{
"code": "INTERNAL_SERVER_ERROR",
"message": "Internal server error",
"issues": []
}Overview
Update an organization threat detection config’s status, schedule, and config fields. To create a new config for a source that is disabled by default, use Create Detection Config first. To durably disable a source that is enabled by default, setstatus to DISABLED
here rather than calling Delete Detection Config,
since automation may re-create a default config for such sources.Authorizations
Your API key. This is required by most endpoints to access our API programatically. Reach out to us at support@chainpatrol.io to get an API key for your use.
Body
application/json
Minimum string length:
1Required range:
x > 0Available options:
ENABLED, DEPRECATED_EVALUATE, DISABLED Show child attributes
Show child attributes
Optional brand connection for this detection config. Pass null to clear the link. Only valid for org-scoped configs; the brand must belong to the same organization.
Required range:
x > 0Response
Successful response
Show child attributes
Show child attributes
Was this page helpful?
⌘I