cURL
curl -X PUT "https://app.cotool.ai/api/detection-authoring/drafts/:chatId" \
-H "Authorization: Bearer YOUR_API_KEY" \
-H "Content-Type: application/json" \
-d '{"name":"string","description":"string","query":"string","mitreTechniqueIds":["string"],"mitreTechniqueNames":["string"],"dataSourcesRequired":["string"],"detectionIntent":{"methodLabel":"string","rationale":"string","confidence":"high","keyKnobs":null},"platformConfig":{"version":1,"platform":"datadog","queries":[{"name":"string","query":"string","aggregation":"count","dataSource":null,"groupByFields":["string"],"distinctFields":["string"]}],"cases":[{"status":"info","condition":"string","name":"string"}],"options":{"detectionMethod":"threshold","evaluationWindow":0,"keepAlive":0,"maxSignalDuration":0,"decreaseCriticalityBasedOnEnv":true},"isEnabled":true}}'import requests
url = "https://app.cotool.ai/api/detection-authoring/drafts/{chatId}"
payload = {
"name": "<string>",
"description": "<string>",
"query": "<string>",
"mitreTechniqueIds": ["<string>"],
"mitreTechniqueNames": ["<string>"],
"dataSourcesRequired": ["<string>"],
"detectionIntent": {
"methodLabel": "<string>",
"rationale": "<string>",
"keyKnobs": {}
},
"platformConfig": {
"version": 123,
"platform": "<string>",
"queries": [
{
"name": "<string>",
"query": "<string>",
"dataSource": "logs",
"groupByFields": ["<string>"],
"distinctFields": ["<string>"]
}
],
"cases": [
{
"condition": "<string>",
"name": "<string>"
}
],
"options": {
"evaluationWindow": 123,
"keepAlive": 123,
"maxSignalDuration": 123,
"decreaseCriticalityBasedOnEnv": True
},
"isEnabled": True
}
}
headers = {
"Authorization": "Bearer <token>",
"Content-Type": "application/json"
}
response = requests.put(url, json=payload, headers=headers)
print(response.text)const options = {
method: 'PUT',
headers: {Authorization: 'Bearer <token>', 'Content-Type': 'application/json'},
body: JSON.stringify({
name: '<string>',
description: '<string>',
query: '<string>',
mitreTechniqueIds: ['<string>'],
mitreTechniqueNames: ['<string>'],
dataSourcesRequired: ['<string>'],
detectionIntent: {methodLabel: '<string>', rationale: '<string>', keyKnobs: {}},
platformConfig: {
version: 123,
platform: '<string>',
queries: [
{
name: '<string>',
query: '<string>',
dataSource: 'logs',
groupByFields: ['<string>'],
distinctFields: ['<string>']
}
],
cases: [{condition: '<string>', name: '<string>'}],
options: {
evaluationWindow: 123,
keepAlive: 123,
maxSignalDuration: 123,
decreaseCriticalityBasedOnEnv: true
},
isEnabled: true
}
})
};
fetch('https://app.cotool.ai/api/detection-authoring/drafts/{chatId}', options)
.then(res => res.json())
.then(res => console.log(res))
.catch(err => console.error(err));HttpResponse<String> response = Unirest.put("https://app.cotool.ai/api/detection-authoring/drafts/{chatId}")
.header("Authorization", "Bearer <token>")
.header("Content-Type", "application/json")
.body("{\n \"name\": \"<string>\",\n \"description\": \"<string>\",\n \"query\": \"<string>\",\n \"mitreTechniqueIds\": [\n \"<string>\"\n ],\n \"mitreTechniqueNames\": [\n \"<string>\"\n ],\n \"dataSourcesRequired\": [\n \"<string>\"\n ],\n \"detectionIntent\": {\n \"methodLabel\": \"<string>\",\n \"rationale\": \"<string>\",\n \"keyKnobs\": {}\n },\n \"platformConfig\": {\n \"version\": 123,\n \"platform\": \"<string>\",\n \"queries\": [\n {\n \"name\": \"<string>\",\n \"query\": \"<string>\",\n \"dataSource\": \"logs\",\n \"groupByFields\": [\n \"<string>\"\n ],\n \"distinctFields\": [\n \"<string>\"\n ]\n }\n ],\n \"cases\": [\n {\n \"condition\": \"<string>\",\n \"name\": \"<string>\"\n }\n ],\n \"options\": {\n \"evaluationWindow\": 123,\n \"keepAlive\": 123,\n \"maxSignalDuration\": 123,\n \"decreaseCriticalityBasedOnEnv\": true\n },\n \"isEnabled\": true\n }\n}")
.asString();package main
import (
"fmt"
"strings"
"net/http"
"io"
)
func main() {
url := "https://app.cotool.ai/api/detection-authoring/drafts/{chatId}"
payload := strings.NewReader("{\n \"name\": \"<string>\",\n \"description\": \"<string>\",\n \"query\": \"<string>\",\n \"mitreTechniqueIds\": [\n \"<string>\"\n ],\n \"mitreTechniqueNames\": [\n \"<string>\"\n ],\n \"dataSourcesRequired\": [\n \"<string>\"\n ],\n \"detectionIntent\": {\n \"methodLabel\": \"<string>\",\n \"rationale\": \"<string>\",\n \"keyKnobs\": {}\n },\n \"platformConfig\": {\n \"version\": 123,\n \"platform\": \"<string>\",\n \"queries\": [\n {\n \"name\": \"<string>\",\n \"query\": \"<string>\",\n \"dataSource\": \"logs\",\n \"groupByFields\": [\n \"<string>\"\n ],\n \"distinctFields\": [\n \"<string>\"\n ]\n }\n ],\n \"cases\": [\n {\n \"condition\": \"<string>\",\n \"name\": \"<string>\"\n }\n ],\n \"options\": {\n \"evaluationWindow\": 123,\n \"keepAlive\": 123,\n \"maxSignalDuration\": 123,\n \"decreaseCriticalityBasedOnEnv\": true\n },\n \"isEnabled\": true\n }\n}")
req, _ := http.NewRequest("PUT", 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))
}{
"chatId": "3c90c3cc-0d44-4b50-8888-8dd25736052a",
"organizationId": "3c90c3cc-0d44-4b50-8888-8dd25736052a",
"platform": "<string>",
"name": "<string>",
"description": "<string>",
"query": "<string>",
"mitreTechniqueIds": [
"<string>"
],
"mitreTechniqueNames": [
"<string>"
],
"dataSourcesRequired": [
"<string>"
],
"createdAt": "<string>",
"updatedAt": "<string>",
"proposalId": "3c90c3cc-0d44-4b50-8888-8dd25736052a",
"reasoning": "<string>",
"detectionIntent": {
"methodLabel": "<string>",
"rationale": "<string>",
"keyKnobs": {}
},
"platformConfig": {
"version": 123,
"platform": "<string>",
"queries": [
{
"name": "<string>",
"query": "<string>",
"dataSource": "logs",
"groupByFields": [
"<string>"
],
"distinctFields": [
"<string>"
]
}
],
"cases": [
{
"condition": "<string>",
"name": "<string>"
}
],
"options": {
"evaluationWindow": 123,
"keepAlive": 123,
"maxSignalDuration": 123,
"decreaseCriticalityBasedOnEnv": true
},
"isEnabled": true
},
"prUrl": "<string>",
"deployedAt": "<string>",
"sourcePrUrl": "<string>",
"sourcePublishedAt": "<string>",
"isUnmodifiedFromSource": true
}{
"error": "<string>",
"issues": [
{}
]
}{
"error": "<string>"
}{
"error": "<string>",
"missingPerms": [
"<string>"
]
}{
"error": "<string>"
}Detection Authoring
Update a detection authoring draft
Updates an existing draft with new field values.
PUT
/
api
/
detection-authoring
/
drafts
/
{chatId}
cURL
curl -X PUT "https://app.cotool.ai/api/detection-authoring/drafts/:chatId" \
-H "Authorization: Bearer YOUR_API_KEY" \
-H "Content-Type: application/json" \
-d '{"name":"string","description":"string","query":"string","mitreTechniqueIds":["string"],"mitreTechniqueNames":["string"],"dataSourcesRequired":["string"],"detectionIntent":{"methodLabel":"string","rationale":"string","confidence":"high","keyKnobs":null},"platformConfig":{"version":1,"platform":"datadog","queries":[{"name":"string","query":"string","aggregation":"count","dataSource":null,"groupByFields":["string"],"distinctFields":["string"]}],"cases":[{"status":"info","condition":"string","name":"string"}],"options":{"detectionMethod":"threshold","evaluationWindow":0,"keepAlive":0,"maxSignalDuration":0,"decreaseCriticalityBasedOnEnv":true},"isEnabled":true}}'import requests
url = "https://app.cotool.ai/api/detection-authoring/drafts/{chatId}"
payload = {
"name": "<string>",
"description": "<string>",
"query": "<string>",
"mitreTechniqueIds": ["<string>"],
"mitreTechniqueNames": ["<string>"],
"dataSourcesRequired": ["<string>"],
"detectionIntent": {
"methodLabel": "<string>",
"rationale": "<string>",
"keyKnobs": {}
},
"platformConfig": {
"version": 123,
"platform": "<string>",
"queries": [
{
"name": "<string>",
"query": "<string>",
"dataSource": "logs",
"groupByFields": ["<string>"],
"distinctFields": ["<string>"]
}
],
"cases": [
{
"condition": "<string>",
"name": "<string>"
}
],
"options": {
"evaluationWindow": 123,
"keepAlive": 123,
"maxSignalDuration": 123,
"decreaseCriticalityBasedOnEnv": True
},
"isEnabled": True
}
}
headers = {
"Authorization": "Bearer <token>",
"Content-Type": "application/json"
}
response = requests.put(url, json=payload, headers=headers)
print(response.text)const options = {
method: 'PUT',
headers: {Authorization: 'Bearer <token>', 'Content-Type': 'application/json'},
body: JSON.stringify({
name: '<string>',
description: '<string>',
query: '<string>',
mitreTechniqueIds: ['<string>'],
mitreTechniqueNames: ['<string>'],
dataSourcesRequired: ['<string>'],
detectionIntent: {methodLabel: '<string>', rationale: '<string>', keyKnobs: {}},
platformConfig: {
version: 123,
platform: '<string>',
queries: [
{
name: '<string>',
query: '<string>',
dataSource: 'logs',
groupByFields: ['<string>'],
distinctFields: ['<string>']
}
],
cases: [{condition: '<string>', name: '<string>'}],
options: {
evaluationWindow: 123,
keepAlive: 123,
maxSignalDuration: 123,
decreaseCriticalityBasedOnEnv: true
},
isEnabled: true
}
})
};
fetch('https://app.cotool.ai/api/detection-authoring/drafts/{chatId}', options)
.then(res => res.json())
.then(res => console.log(res))
.catch(err => console.error(err));HttpResponse<String> response = Unirest.put("https://app.cotool.ai/api/detection-authoring/drafts/{chatId}")
.header("Authorization", "Bearer <token>")
.header("Content-Type", "application/json")
.body("{\n \"name\": \"<string>\",\n \"description\": \"<string>\",\n \"query\": \"<string>\",\n \"mitreTechniqueIds\": [\n \"<string>\"\n ],\n \"mitreTechniqueNames\": [\n \"<string>\"\n ],\n \"dataSourcesRequired\": [\n \"<string>\"\n ],\n \"detectionIntent\": {\n \"methodLabel\": \"<string>\",\n \"rationale\": \"<string>\",\n \"keyKnobs\": {}\n },\n \"platformConfig\": {\n \"version\": 123,\n \"platform\": \"<string>\",\n \"queries\": [\n {\n \"name\": \"<string>\",\n \"query\": \"<string>\",\n \"dataSource\": \"logs\",\n \"groupByFields\": [\n \"<string>\"\n ],\n \"distinctFields\": [\n \"<string>\"\n ]\n }\n ],\n \"cases\": [\n {\n \"condition\": \"<string>\",\n \"name\": \"<string>\"\n }\n ],\n \"options\": {\n \"evaluationWindow\": 123,\n \"keepAlive\": 123,\n \"maxSignalDuration\": 123,\n \"decreaseCriticalityBasedOnEnv\": true\n },\n \"isEnabled\": true\n }\n}")
.asString();package main
import (
"fmt"
"strings"
"net/http"
"io"
)
func main() {
url := "https://app.cotool.ai/api/detection-authoring/drafts/{chatId}"
payload := strings.NewReader("{\n \"name\": \"<string>\",\n \"description\": \"<string>\",\n \"query\": \"<string>\",\n \"mitreTechniqueIds\": [\n \"<string>\"\n ],\n \"mitreTechniqueNames\": [\n \"<string>\"\n ],\n \"dataSourcesRequired\": [\n \"<string>\"\n ],\n \"detectionIntent\": {\n \"methodLabel\": \"<string>\",\n \"rationale\": \"<string>\",\n \"keyKnobs\": {}\n },\n \"platformConfig\": {\n \"version\": 123,\n \"platform\": \"<string>\",\n \"queries\": [\n {\n \"name\": \"<string>\",\n \"query\": \"<string>\",\n \"dataSource\": \"logs\",\n \"groupByFields\": [\n \"<string>\"\n ],\n \"distinctFields\": [\n \"<string>\"\n ]\n }\n ],\n \"cases\": [\n {\n \"condition\": \"<string>\",\n \"name\": \"<string>\"\n }\n ],\n \"options\": {\n \"evaluationWindow\": 123,\n \"keepAlive\": 123,\n \"maxSignalDuration\": 123,\n \"decreaseCriticalityBasedOnEnv\": true\n },\n \"isEnabled\": true\n }\n}")
req, _ := http.NewRequest("PUT", 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))
}{
"chatId": "3c90c3cc-0d44-4b50-8888-8dd25736052a",
"organizationId": "3c90c3cc-0d44-4b50-8888-8dd25736052a",
"platform": "<string>",
"name": "<string>",
"description": "<string>",
"query": "<string>",
"mitreTechniqueIds": [
"<string>"
],
"mitreTechniqueNames": [
"<string>"
],
"dataSourcesRequired": [
"<string>"
],
"createdAt": "<string>",
"updatedAt": "<string>",
"proposalId": "3c90c3cc-0d44-4b50-8888-8dd25736052a",
"reasoning": "<string>",
"detectionIntent": {
"methodLabel": "<string>",
"rationale": "<string>",
"keyKnobs": {}
},
"platformConfig": {
"version": 123,
"platform": "<string>",
"queries": [
{
"name": "<string>",
"query": "<string>",
"dataSource": "logs",
"groupByFields": [
"<string>"
],
"distinctFields": [
"<string>"
]
}
],
"cases": [
{
"condition": "<string>",
"name": "<string>"
}
],
"options": {
"evaluationWindow": 123,
"keepAlive": 123,
"maxSignalDuration": 123,
"decreaseCriticalityBasedOnEnv": true
},
"isEnabled": true
},
"prUrl": "<string>",
"deployedAt": "<string>",
"sourcePrUrl": "<string>",
"sourcePublishedAt": "<string>",
"isUnmodifiedFromSource": true
}{
"error": "<string>",
"issues": [
{}
]
}{
"error": "<string>"
}{
"error": "<string>",
"missingPerms": [
"<string>"
]
}{
"error": "<string>"
}Authorizations
API Key authentication for programmatic access. Include your API key in the Authorization header as: Bearer your_api_key_here
Path Parameters
Body
application/json
Response
Successful response
Show child attributes
Show child attributes
- Option 1
- Option 2
Show child attributes
Show child attributes
Available options:
proposed, validated, validation_failed, published, pr_created, merged, rejected, dismissed Was this page helpful?
⌘I