Run detection configs on demand
curl --request POST \
--url https://app.chainpatrol.io/api/v2/detection/configs/run \
--header 'Content-Type: application/json' \
--header 'X-API-KEY: <api-key>' \
--data '
{
"slug": "<string>",
"configId": 1,
"source": "<string>",
"includeDisabled": false
}
'import requests
url = "https://app.chainpatrol.io/api/v2/detection/configs/run"
payload = {
"slug": "<string>",
"configId": 1,
"source": "<string>",
"includeDisabled": False
}
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, source: '<string>', includeDisabled: false})
};
fetch('https://app.chainpatrol.io/api/v2/detection/configs/run', 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/run",
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,
'source' => '<string>',
'includeDisabled' => false
]),
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/run"
payload := strings.NewReader("{\n \"slug\": \"<string>\",\n \"configId\": 1,\n \"source\": \"<string>\",\n \"includeDisabled\": false\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/run")
.header("X-API-KEY", "<api-key>")
.header("Content-Type", "application/json")
.body("{\n \"slug\": \"<string>\",\n \"configId\": 1,\n \"source\": \"<string>\",\n \"includeDisabled\": false\n}")
.asString();require 'uri'
require 'net/http'
url = URI("https://app.chainpatrol.io/api/v2/detection/configs/run")
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 \"source\": \"<string>\",\n \"includeDisabled\": false\n}"
response = http.request(request)
puts response.read_body{
"ranCount": 123,
"successCount": 123,
"failedCount": 123,
"results": [
{
"configId": 123,
"source": "<string>",
"ok": true,
"message": "<string>",
"assetsCount": 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
Run Detection Configs
Run one or many organization detection configs and return run status per config.
POST
/
detection
/
configs
/
run
Run detection configs on demand
curl --request POST \
--url https://app.chainpatrol.io/api/v2/detection/configs/run \
--header 'Content-Type: application/json' \
--header 'X-API-KEY: <api-key>' \
--data '
{
"slug": "<string>",
"configId": 1,
"source": "<string>",
"includeDisabled": false
}
'import requests
url = "https://app.chainpatrol.io/api/v2/detection/configs/run"
payload = {
"slug": "<string>",
"configId": 1,
"source": "<string>",
"includeDisabled": False
}
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, source: '<string>', includeDisabled: false})
};
fetch('https://app.chainpatrol.io/api/v2/detection/configs/run', 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/run",
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,
'source' => '<string>',
'includeDisabled' => false
]),
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/run"
payload := strings.NewReader("{\n \"slug\": \"<string>\",\n \"configId\": 1,\n \"source\": \"<string>\",\n \"includeDisabled\": false\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/run")
.header("X-API-KEY", "<api-key>")
.header("Content-Type", "application/json")
.body("{\n \"slug\": \"<string>\",\n \"configId\": 1,\n \"source\": \"<string>\",\n \"includeDisabled\": false\n}")
.asString();require 'uri'
require 'net/http'
url = URI("https://app.chainpatrol.io/api/v2/detection/configs/run")
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 \"source\": \"<string>\",\n \"includeDisabled\": false\n}"
response = http.request(request)
puts response.read_body{
"ranCount": 123,
"successCount": 123,
"failedCount": 123,
"results": [
{
"configId": 123,
"source": "<string>",
"ok": true,
"message": "<string>",
"assetsCount": 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
Run one or many organization detection configs on demand and return the run status for each config.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
Was this page helpful?
⌘I