Skip to main content
PATCH
/
v1
/
alerts
/
{alert_uuid}
Patch Alert
curl --request PATCH \
  --url https://api.example.com/v1/alerts/{alert_uuid} \
  --header 'Content-Type: application/json' \
  --data '
{
  "tags": [
    "<string>"
  ],
  "reset_malice_override": false
}
'
import requests

url = "https://api.example.com/v1/alerts/{alert_uuid}"

payload = {
    "tags": ["<string>"],
    "reset_malice_override": False
}
headers = {"Content-Type": "application/json"}

response = requests.patch(url, json=payload, headers=headers)

print(response.text)
const options = {
  method: 'PATCH',
  headers: {'Content-Type': 'application/json'},
  body: JSON.stringify({tags: ['<string>'], reset_malice_override: false})
};

fetch('https://api.example.com/v1/alerts/{alert_uuid}', 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://api.example.com/v1/alerts/{alert_uuid}",
  CURLOPT_RETURNTRANSFER => true,
  CURLOPT_ENCODING => "",
  CURLOPT_MAXREDIRS => 10,
  CURLOPT_TIMEOUT => 30,
  CURLOPT_HTTP_VERSION => CURL_HTTP_VERSION_1_1,
  CURLOPT_CUSTOMREQUEST => "PATCH",
  CURLOPT_POSTFIELDS => json_encode([
    'tags' => [
        '<string>'
    ],
    'reset_malice_override' => false
  ]),
  CURLOPT_HTTPHEADER => [
    "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://api.example.com/v1/alerts/{alert_uuid}"

	payload := strings.NewReader("{\n  \"tags\": [\n    \"<string>\"\n  ],\n  \"reset_malice_override\": false\n}")

	req, _ := http.NewRequest("PATCH", url, payload)

	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.patch("https://api.example.com/v1/alerts/{alert_uuid}")
  .header("Content-Type", "application/json")
  .body("{\n  \"tags\": [\n    \"<string>\"\n  ],\n  \"reset_malice_override\": false\n}")
  .asString();
require 'uri'
require 'net/http'

url = URI("https://api.example.com/v1/alerts/{alert_uuid}")

http = Net::HTTP.new(url.host, url.port)
http.use_ssl = true

request = Net::HTTP::Patch.new(url)
request["Content-Type"] = 'application/json'
request.body = "{\n  \"tags\": [\n    \"<string>\"\n  ],\n  \"reset_malice_override\": false\n}"

response = http.request(request)
puts response.read_body
{
  "data": {
    "uuid": "3c90c3cc-0d44-4b50-8888-8dd25736052a",
    "title": "<string>",
    "source_name": "<string>",
    "occurred_at": "2023-11-07T05:31:56Z",
    "ingested_at": "2023-11-07T05:31:56Z",
    "enriched_at": "2023-11-07T05:31:56Z",
    "is_enriched": true,
    "fingerprint": "<string>",
    "acknowledged_at": "2023-11-07T05:31:56Z",
    "triaged_at": "2023-11-07T05:31:56Z",
    "closed_at": "2023-11-07T05:31:56Z",
    "tags": [
      "<string>"
    ],
    "detection_rule_id": 123,
    "created_at": "2023-11-07T05:31:56Z",
    "updated_at": "2023-11-07T05:31:56Z",
    "description": "<string>",
    "duplicate_count": 0,
    "last_seen_at": "2023-11-07T05:31:56Z",
    "raw_payload": {},
    "malice": "<string>",
    "malice_override": "<string>",
    "malice_override_source": "<string>",
    "malice_override_at": "2023-11-07T05:31:56Z",
    "indicators": [
      {
        "uuid": "<string>",
        "value": "<string>",
        "first_seen": "2023-11-07T05:31:56Z",
        "last_seen": "2023-11-07T05:31:56Z",
        "is_enriched": true,
        "malice": "<string>",
        "created_at": "2023-11-07T05:31:56Z",
        "updated_at": "2023-11-07T05:31:56Z",
        "malice_source": "<string>",
        "malice_overridden_at": "2023-11-07T05:31:56Z",
        "enrichment_results": {}
      }
    ],
    "detection_rule": {
      "uuid": "3c90c3cc-0d44-4b50-8888-8dd25736052a",
      "name": "<string>",
      "source_rule_id": "<string>",
      "source_name": "<string>",
      "severity": "<string>",
      "is_active": true,
      "mitre_tactics": [
        "<string>"
      ],
      "mitre_techniques": [
        "<string>"
      ],
      "mitre_subtechniques": [
        "<string>"
      ],
      "data_sources": [
        "<string>"
      ],
      "run_frequency": "<string>",
      "created_by": "<string>",
      "documentation": "<string>",
      "created_at": "2023-11-07T05:31:56Z",
      "updated_at": "2023-11-07T05:31:56Z"
    },
    "context_documents": [
      {
        "uuid": "3c90c3cc-0d44-4b50-8888-8dd25736052a",
        "title": "<string>",
        "document_type": "<string>",
        "is_global": true,
        "description": "<string>",
        "tags": [
          "<string>"
        ],
        "version": 123,
        "created_at": "2023-11-07T05:31:56Z",
        "updated_at": "2023-11-07T05:31:56Z",
        "content": "<string>",
        "targeting_rules": {}
      }
    ],
    "agent_findings": [
      {}
    ]
  },
  "meta": {}
}
{
  "detail": [
    {
      "loc": [
        "<string>"
      ],
      "msg": "<string>",
      "type": "<string>",
      "input": "<unknown>",
      "ctx": {}
    }
  ]
}

Path Parameters

alert_uuid
string<uuid>
required

Body

application/json

Patch request for updating an alert — PATCH /v1/alerts/{uuid}. All fields optional. If status=Closed, close_classification is required.

status
enum<string> | null

Alert investigation lifecycle status. Stored as TEXT with Pydantic validation. Do NOT use a Postgres ENUM type — TEXT with app-level validation is easier to migrate.

Transition flow: Open → Triaging / Escalated → Closed

Available options:
Open,
Triaging,
Escalated,
Closed
severity
enum<string> | null

Alert severity levels. Stored as TEXT with Pydantic validation. Source plugins are responsible for mapping source-specific severity values to this enum.

Available options:
Pending,
Informational,
Low,
Medium,
High,
Critical
close_classification
enum<string> | null

Required when status transitions to Closed. Used for FP rate metrics and detection quality. Any value starting with 'False Positive' counts toward the false_positive_rate metric.

Available options:
True Positive - Suspicious Activity,
Benign Positive - Suspicious but Expected,
False Positive - Incorrect Detection Logic,
False Positive - Inaccurate Data,
Undetermined,
Duplicate,
Not Applicable
tags
string[] | null
malice_override
enum<string> | null

Indicator malice verdict — shared validation enum.

Available options:
Pending,
Benign,
Suspicious,
Malicious
reset_malice_override
boolean
default:false

Response

Successful Response

data
AlertResponse · object
required

Full alert response — returned by GET /v1/alerts/{uuid}.

meta
Meta · object