Update detection output configuration

cURL

curl -X PUT "https://app.cotool.ai/api/detections/:id/outputs" \
  -H "Authorization: Bearer YOUR_API_KEY" \
  -H "Content-Type: application/json" \
  -d '{"enabled":true,"destinationIds":["string"],"sendMode":"triggered_entities_only","minSeverity":"low","inheritOrgDefault":true}'

import requests

url = "https://app.cotool.ai/api/detections/{id}/outputs"

payload = {
    "enabled": True,
    "destinationIds": ["3c90c3cc-0d44-4b50-8888-8dd25736052a"],
    "inheritOrgDefault": 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({
    enabled: true,
    destinationIds: ['3c90c3cc-0d44-4b50-8888-8dd25736052a'],
    inheritOrgDefault: true
  })
};

fetch('https://app.cotool.ai/api/detections/{id}/outputs', 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/detections/{id}/outputs")
  .header("Authorization", "Bearer <token>")
  .header("Content-Type", "application/json")
  .body("{\n  \"enabled\": true,\n  \"destinationIds\": [\n    \"3c90c3cc-0d44-4b50-8888-8dd25736052a\"\n  ],\n  \"inheritOrgDefault\": true\n}")
  .asString();

package main

import (
	"fmt"
	"strings"
	"net/http"
	"io"
)

func main() {

	url := "https://app.cotool.ai/api/detections/{id}/outputs"

	payload := strings.NewReader("{\n  \"enabled\": true,\n  \"destinationIds\": [\n    \"3c90c3cc-0d44-4b50-8888-8dd25736052a\"\n  ],\n  \"inheritOrgDefault\": true\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))

}

{
  "id": "3c90c3cc-0d44-4b50-8888-8dd25736052a",
  "organizationId": "3c90c3cc-0d44-4b50-8888-8dd25736052a",
  "agentId": "3c90c3cc-0d44-4b50-8888-8dd25736052a",
  "enabled": true,
  "destinationIds": [
    "3c90c3cc-0d44-4b50-8888-8dd25736052a"
  ],
  "createdAt": "<string>",
  "updatedAt": "<string>",
  "acNotificationsEnabled": true,
  "acNotificationDestinationIds": [
    "3c90c3cc-0d44-4b50-8888-8dd25736052a"
  ],
  "acNotificationsInheritOrgDefault": true,
  "settings": {
    "id": "3c90c3cc-0d44-4b50-8888-8dd25736052a",
    "organizationId": "3c90c3cc-0d44-4b50-8888-8dd25736052a",
    "agentId": "3c90c3cc-0d44-4b50-8888-8dd25736052a",
    "enabled": true,
    "destinationIds": [
      "3c90c3cc-0d44-4b50-8888-8dd25736052a"
    ],
    "createdAt": "<string>",
    "updatedAt": "<string>",
    "acNotificationsEnabled": true,
    "acNotificationDestinationIds": [
      "3c90c3cc-0d44-4b50-8888-8dd25736052a"
    ],
    "acNotificationsInheritOrgDefault": true
  },
  "effectiveSettings": {
    "enabled": true,
    "destinationIds": [
      "3c90c3cc-0d44-4b50-8888-8dd25736052a"
    ]
  },
  "organizationDefaultSettings": {
    "id": "3c90c3cc-0d44-4b50-8888-8dd25736052a",
    "organizationId": "3c90c3cc-0d44-4b50-8888-8dd25736052a",
    "enabled": true,
    "destinationIds": [
      "3c90c3cc-0d44-4b50-8888-8dd25736052a"
    ],
    "createdAt": "<string>",
    "updatedAt": "<string>"
  },
  "destinations": [
    {
      "id": "3c90c3cc-0d44-4b50-8888-8dd25736052a",
      "organizationId": "3c90c3cc-0d44-4b50-8888-8dd25736052a",
      "name": "<string>",
      "createdAt": "<string>",
      "updatedAt": "<string>",
      "type": "webhook",
      "config": {
        "url": "<string>",
        "headerName": "<string>"
      },
      "token": "<string>",
      "hasToken": true
    }
  ]
}

{
  "error": "<string>",
  "issues": [
    {}
  ]
}

{
  "error": "<string>"
}

{
  "error": "<string>",
  "missingPerms": [
    "<string>"
  ]
}

{
  "error": "<string>"
}

PUT

api

detections

{id}

outputs

cURL

curl -X PUT "https://app.cotool.ai/api/detections/:id/outputs" \
  -H "Authorization: Bearer YOUR_API_KEY" \
  -H "Content-Type: application/json" \
  -d '{"enabled":true,"destinationIds":["string"],"sendMode":"triggered_entities_only","minSeverity":"low","inheritOrgDefault":true}'

import requests

url = "https://app.cotool.ai/api/detections/{id}/outputs"

payload = {
    "enabled": True,
    "destinationIds": ["3c90c3cc-0d44-4b50-8888-8dd25736052a"],
    "inheritOrgDefault": 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({
    enabled: true,
    destinationIds: ['3c90c3cc-0d44-4b50-8888-8dd25736052a'],
    inheritOrgDefault: true
  })
};

fetch('https://app.cotool.ai/api/detections/{id}/outputs', 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/detections/{id}/outputs")
  .header("Authorization", "Bearer <token>")
  .header("Content-Type", "application/json")
  .body("{\n  \"enabled\": true,\n  \"destinationIds\": [\n    \"3c90c3cc-0d44-4b50-8888-8dd25736052a\"\n  ],\n  \"inheritOrgDefault\": true\n}")
  .asString();

package main

import (
	"fmt"
	"strings"
	"net/http"
	"io"
)

func main() {

	url := "https://app.cotool.ai/api/detections/{id}/outputs"

	payload := strings.NewReader("{\n  \"enabled\": true,\n  \"destinationIds\": [\n    \"3c90c3cc-0d44-4b50-8888-8dd25736052a\"\n  ],\n  \"inheritOrgDefault\": true\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))

}

{
  "id": "3c90c3cc-0d44-4b50-8888-8dd25736052a",
  "organizationId": "3c90c3cc-0d44-4b50-8888-8dd25736052a",
  "agentId": "3c90c3cc-0d44-4b50-8888-8dd25736052a",
  "enabled": true,
  "destinationIds": [
    "3c90c3cc-0d44-4b50-8888-8dd25736052a"
  ],
  "createdAt": "<string>",
  "updatedAt": "<string>",
  "acNotificationsEnabled": true,
  "acNotificationDestinationIds": [
    "3c90c3cc-0d44-4b50-8888-8dd25736052a"
  ],
  "acNotificationsInheritOrgDefault": true,
  "settings": {
    "id": "3c90c3cc-0d44-4b50-8888-8dd25736052a",
    "organizationId": "3c90c3cc-0d44-4b50-8888-8dd25736052a",
    "agentId": "3c90c3cc-0d44-4b50-8888-8dd25736052a",
    "enabled": true,
    "destinationIds": [
      "3c90c3cc-0d44-4b50-8888-8dd25736052a"
    ],
    "createdAt": "<string>",
    "updatedAt": "<string>",
    "acNotificationsEnabled": true,
    "acNotificationDestinationIds": [
      "3c90c3cc-0d44-4b50-8888-8dd25736052a"
    ],
    "acNotificationsInheritOrgDefault": true
  },
  "effectiveSettings": {
    "enabled": true,
    "destinationIds": [
      "3c90c3cc-0d44-4b50-8888-8dd25736052a"
    ]
  },
  "organizationDefaultSettings": {
    "id": "3c90c3cc-0d44-4b50-8888-8dd25736052a",
    "organizationId": "3c90c3cc-0d44-4b50-8888-8dd25736052a",
    "enabled": true,
    "destinationIds": [
      "3c90c3cc-0d44-4b50-8888-8dd25736052a"
    ],
    "createdAt": "<string>",
    "updatedAt": "<string>"
  },
  "destinations": [
    {
      "id": "3c90c3cc-0d44-4b50-8888-8dd25736052a",
      "organizationId": "3c90c3cc-0d44-4b50-8888-8dd25736052a",
      "name": "<string>",
      "createdAt": "<string>",
      "updatedAt": "<string>",
      "type": "webhook",
      "config": {
        "url": "<string>",
        "headerName": "<string>"
      },
      "token": "<string>",
      "hasToken": true
    }
  ]
}

{
  "error": "<string>",
  "issues": [
    {}
  ]
}

{
  "error": "<string>"
}

{
  "error": "<string>",
  "missingPerms": [
    "<string>"
  ]
}

{
  "error": "<string>"
}

Authorizations

Authorization

string

header

required

API Key authentication for programmatic access. Include your API key in the Authorization header as: Bearer your_api_key_here

Path Parameters

string<uuid>

required

Detection UUID

Body

application/json

enabled

boolean

required

Whether output delivery is enabled

destinationIds

string<uuid>[]

required

The output destinations to use

sendMode

enum<string>

required

What entities to send

Available options:

triggered_entities_only,

all_entities

minSeverity

enum<string>

Minimum entity severity eligible for output delivery; defaults to high when omitted

Available options:

low,

medium,

high,

critical

inheritOrgDefault

boolean

When true, remove the detection override and inherit organization defaults

Response

Successful response

string<uuid>

required

Unique identifier for the settings

organizationId

string<uuid>

required

Organization that owns this settings

agentId

string<uuid>

required

Agent these settings apply to

enabled

boolean

required

Whether output delivery is enabled

destinationIds

string<uuid>[]

required

The output destinations to use

sendMode

enum<string>

required

What entities to send

Available options:

triggered_entities_only,

all_entities

minSeverity

enum<string>

required

Minimum entity severity eligible for detection output delivery

Available options:

low,

medium,

high,

critical

createdAt

string

required

When the settings were created

updatedAt

string

required

When the settings were last updated

acNotificationsEnabled

boolean

Whether acceptance criteria failure notifications are enabled

acNotificationDestinationIds

string<uuid>[]

Destinations for acceptance criteria failure notifications

acNotificationsInheritOrgDefault

boolean

Whether response-agent failure/critical notifications inherit organization defaults

settings

object | null

Override settings for this detection, if configured

Show child attributes

effectiveSettings

object

Effective output settings after applying organization defaults

Show child attributes

organizationDefaultSettings

object

Organization-wide default output settings for detections

Show child attributes

destinations

object[]

Available output destinations for the organization

Show child attributes

⌘I