Update an alert
curl --request PATCH \
--url https://api.coval.dev/v1/alerts/{alert_id} \
--header 'Content-Type: application/json' \
--header 'X-API-Key: <api-key>' \
--data '
{
"name": "<string>",
"description": "<string>",
"evaluation_type": "ON_RUN_COMPLETE",
"cooldown_seconds": 43200,
"custom_message_template": "<string>",
"agent_ids": [
"<string>"
],
"required_tags": [
"<string>"
],
"scheduled_run_ids": [
"<string>"
],
"conditions": [
{
"metric_id": "<string>",
"threshold_float": 123,
"threshold_string": "<string>",
"window_size_days": 183,
"window_size_runs": 5000,
"match_value": "<string>"
}
],
"channels": [
{
"config": {}
}
]
}
'import requests
url = "https://api.coval.dev/v1/alerts/{alert_id}"
payload = {
"name": "<string>",
"description": "<string>",
"evaluation_type": "ON_RUN_COMPLETE",
"cooldown_seconds": 43200,
"custom_message_template": "<string>",
"agent_ids": ["<string>"],
"required_tags": ["<string>"],
"scheduled_run_ids": ["<string>"],
"conditions": [
{
"metric_id": "<string>",
"threshold_float": 123,
"threshold_string": "<string>",
"window_size_days": 183,
"window_size_runs": 5000,
"match_value": "<string>"
}
],
"channels": [{ "config": {} }]
}
headers = {
"X-API-Key": "<api-key>",
"Content-Type": "application/json"
}
response = requests.patch(url, json=payload, headers=headers)
print(response.text)const options = {
method: 'PATCH',
headers: {'X-API-Key': '<api-key>', 'Content-Type': 'application/json'},
body: JSON.stringify({
name: '<string>',
description: '<string>',
evaluation_type: 'ON_RUN_COMPLETE',
cooldown_seconds: 43200,
custom_message_template: '<string>',
agent_ids: ['<string>'],
required_tags: ['<string>'],
scheduled_run_ids: ['<string>'],
conditions: [
{
metric_id: '<string>',
threshold_float: 123,
threshold_string: '<string>',
window_size_days: 183,
window_size_runs: 5000,
match_value: '<string>'
}
],
channels: [{config: {}}]
})
};
fetch('https://api.coval.dev/v1/alerts/{alert_id}', 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.coval.dev/v1/alerts/{alert_id}",
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([
'name' => '<string>',
'description' => '<string>',
'evaluation_type' => 'ON_RUN_COMPLETE',
'cooldown_seconds' => 43200,
'custom_message_template' => '<string>',
'agent_ids' => [
'<string>'
],
'required_tags' => [
'<string>'
],
'scheduled_run_ids' => [
'<string>'
],
'conditions' => [
[
'metric_id' => '<string>',
'threshold_float' => 123,
'threshold_string' => '<string>',
'window_size_days' => 183,
'window_size_runs' => 5000,
'match_value' => '<string>'
]
],
'channels' => [
[
'config' => [
]
]
]
]),
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://api.coval.dev/v1/alerts/{alert_id}"
payload := strings.NewReader("{\n \"name\": \"<string>\",\n \"description\": \"<string>\",\n \"evaluation_type\": \"ON_RUN_COMPLETE\",\n \"cooldown_seconds\": 43200,\n \"custom_message_template\": \"<string>\",\n \"agent_ids\": [\n \"<string>\"\n ],\n \"required_tags\": [\n \"<string>\"\n ],\n \"scheduled_run_ids\": [\n \"<string>\"\n ],\n \"conditions\": [\n {\n \"metric_id\": \"<string>\",\n \"threshold_float\": 123,\n \"threshold_string\": \"<string>\",\n \"window_size_days\": 183,\n \"window_size_runs\": 5000,\n \"match_value\": \"<string>\"\n }\n ],\n \"channels\": [\n {\n \"config\": {}\n }\n ]\n}")
req, _ := http.NewRequest("PATCH", 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.patch("https://api.coval.dev/v1/alerts/{alert_id}")
.header("X-API-Key", "<api-key>")
.header("Content-Type", "application/json")
.body("{\n \"name\": \"<string>\",\n \"description\": \"<string>\",\n \"evaluation_type\": \"ON_RUN_COMPLETE\",\n \"cooldown_seconds\": 43200,\n \"custom_message_template\": \"<string>\",\n \"agent_ids\": [\n \"<string>\"\n ],\n \"required_tags\": [\n \"<string>\"\n ],\n \"scheduled_run_ids\": [\n \"<string>\"\n ],\n \"conditions\": [\n {\n \"metric_id\": \"<string>\",\n \"threshold_float\": 123,\n \"threshold_string\": \"<string>\",\n \"window_size_days\": 183,\n \"window_size_runs\": 5000,\n \"match_value\": \"<string>\"\n }\n ],\n \"channels\": [\n {\n \"config\": {}\n }\n ]\n}")
.asString();require 'uri'
require 'net/http'
url = URI("https://api.coval.dev/v1/alerts/{alert_id}")
http = Net::HTTP.new(url.host, url.port)
http.use_ssl = true
request = Net::HTTP::Patch.new(url)
request["X-API-Key"] = '<api-key>'
request["Content-Type"] = 'application/json'
request.body = "{\n \"name\": \"<string>\",\n \"description\": \"<string>\",\n \"evaluation_type\": \"ON_RUN_COMPLETE\",\n \"cooldown_seconds\": 43200,\n \"custom_message_template\": \"<string>\",\n \"agent_ids\": [\n \"<string>\"\n ],\n \"required_tags\": [\n \"<string>\"\n ],\n \"scheduled_run_ids\": [\n \"<string>\"\n ],\n \"conditions\": [\n {\n \"metric_id\": \"<string>\",\n \"threshold_float\": 123,\n \"threshold_string\": \"<string>\",\n \"window_size_days\": 183,\n \"window_size_runs\": 5000,\n \"match_value\": \"<string>\"\n }\n ],\n \"channels\": [\n {\n \"config\": {}\n }\n ]\n}"
response = http.request(request)
puts response.read_body{
"ulid": "01HZ0EXAMPLE00000000000000",
"name": "Latency SLA Alert",
"evaluation_type": "ON_RUN_COMPLETE",
"cooldown_seconds": 43200,
"trigger_count": 123,
"conditions": [
{
"ulid": "<string>",
"metric_id": "<string>",
"threshold_float": 123,
"threshold_string": "<string>",
"window_size_days": 183,
"window_size_runs": 5000,
"match_value": "<string>"
}
],
"channels": [
{
"ulid": "<string>",
"config": {}
}
],
"create_time": "2023-11-07T05:31:56Z",
"update_time": "2023-11-07T05:31:56Z",
"description": "",
"custom_message_template": "<string>",
"agent_ids": [
"<string>"
],
"required_tags": [
"<string>"
],
"scheduled_run_ids": [
"<string>"
],
"last_triggered_at": "2023-11-07T05:31:56Z"
}{
"error": {
"code": "INVALID_ARGUMENT",
"message": "Invalid request body",
"details": [
{
"field": "conditions",
"description": "Value error, List should have at least 1 item after validation"
}
]
}
}{
"error": {
"code": "UNAUTHENTICATED",
"message": "Authentication failed",
"details": [
{
"field": "X-API-Key",
"description": "Invalid or missing API key"
}
]
}
}{
"error": {
"code": "PERMISSION_DENIED",
"message": "Insufficient permissions",
"details": [
{
"field": "permissions",
"description": "Required scope: alerts:read"
}
]
}
}{
"error": {
"code": "NOT_FOUND",
"message": "Alert not found",
"details": [
{
"field": "alert_id",
"description": "Alert '01HZ0EXAMPLE00000000000000' not found"
}
]
}
}{
"error": {
"message": "<string>",
"details": [
{
"field": "<string>",
"description": "<string>"
}
]
}
}{
"error": {
"code": "INTERNAL",
"message": "Internal server error",
"details": [
{
"description": "An unexpected error occurred"
}
]
}
}Alerts
Update an alert
Partially updates an alert. All fields are optional; omitted fields retain their current values (PATCH semantics).
When conditions or channels are provided, they replace the
existing set atomically (delete old, create new).
PATCH
/
alerts
/
{alert_id}
Update an alert
curl --request PATCH \
--url https://api.coval.dev/v1/alerts/{alert_id} \
--header 'Content-Type: application/json' \
--header 'X-API-Key: <api-key>' \
--data '
{
"name": "<string>",
"description": "<string>",
"evaluation_type": "ON_RUN_COMPLETE",
"cooldown_seconds": 43200,
"custom_message_template": "<string>",
"agent_ids": [
"<string>"
],
"required_tags": [
"<string>"
],
"scheduled_run_ids": [
"<string>"
],
"conditions": [
{
"metric_id": "<string>",
"threshold_float": 123,
"threshold_string": "<string>",
"window_size_days": 183,
"window_size_runs": 5000,
"match_value": "<string>"
}
],
"channels": [
{
"config": {}
}
]
}
'import requests
url = "https://api.coval.dev/v1/alerts/{alert_id}"
payload = {
"name": "<string>",
"description": "<string>",
"evaluation_type": "ON_RUN_COMPLETE",
"cooldown_seconds": 43200,
"custom_message_template": "<string>",
"agent_ids": ["<string>"],
"required_tags": ["<string>"],
"scheduled_run_ids": ["<string>"],
"conditions": [
{
"metric_id": "<string>",
"threshold_float": 123,
"threshold_string": "<string>",
"window_size_days": 183,
"window_size_runs": 5000,
"match_value": "<string>"
}
],
"channels": [{ "config": {} }]
}
headers = {
"X-API-Key": "<api-key>",
"Content-Type": "application/json"
}
response = requests.patch(url, json=payload, headers=headers)
print(response.text)const options = {
method: 'PATCH',
headers: {'X-API-Key': '<api-key>', 'Content-Type': 'application/json'},
body: JSON.stringify({
name: '<string>',
description: '<string>',
evaluation_type: 'ON_RUN_COMPLETE',
cooldown_seconds: 43200,
custom_message_template: '<string>',
agent_ids: ['<string>'],
required_tags: ['<string>'],
scheduled_run_ids: ['<string>'],
conditions: [
{
metric_id: '<string>',
threshold_float: 123,
threshold_string: '<string>',
window_size_days: 183,
window_size_runs: 5000,
match_value: '<string>'
}
],
channels: [{config: {}}]
})
};
fetch('https://api.coval.dev/v1/alerts/{alert_id}', 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.coval.dev/v1/alerts/{alert_id}",
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([
'name' => '<string>',
'description' => '<string>',
'evaluation_type' => 'ON_RUN_COMPLETE',
'cooldown_seconds' => 43200,
'custom_message_template' => '<string>',
'agent_ids' => [
'<string>'
],
'required_tags' => [
'<string>'
],
'scheduled_run_ids' => [
'<string>'
],
'conditions' => [
[
'metric_id' => '<string>',
'threshold_float' => 123,
'threshold_string' => '<string>',
'window_size_days' => 183,
'window_size_runs' => 5000,
'match_value' => '<string>'
]
],
'channels' => [
[
'config' => [
]
]
]
]),
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://api.coval.dev/v1/alerts/{alert_id}"
payload := strings.NewReader("{\n \"name\": \"<string>\",\n \"description\": \"<string>\",\n \"evaluation_type\": \"ON_RUN_COMPLETE\",\n \"cooldown_seconds\": 43200,\n \"custom_message_template\": \"<string>\",\n \"agent_ids\": [\n \"<string>\"\n ],\n \"required_tags\": [\n \"<string>\"\n ],\n \"scheduled_run_ids\": [\n \"<string>\"\n ],\n \"conditions\": [\n {\n \"metric_id\": \"<string>\",\n \"threshold_float\": 123,\n \"threshold_string\": \"<string>\",\n \"window_size_days\": 183,\n \"window_size_runs\": 5000,\n \"match_value\": \"<string>\"\n }\n ],\n \"channels\": [\n {\n \"config\": {}\n }\n ]\n}")
req, _ := http.NewRequest("PATCH", 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.patch("https://api.coval.dev/v1/alerts/{alert_id}")
.header("X-API-Key", "<api-key>")
.header("Content-Type", "application/json")
.body("{\n \"name\": \"<string>\",\n \"description\": \"<string>\",\n \"evaluation_type\": \"ON_RUN_COMPLETE\",\n \"cooldown_seconds\": 43200,\n \"custom_message_template\": \"<string>\",\n \"agent_ids\": [\n \"<string>\"\n ],\n \"required_tags\": [\n \"<string>\"\n ],\n \"scheduled_run_ids\": [\n \"<string>\"\n ],\n \"conditions\": [\n {\n \"metric_id\": \"<string>\",\n \"threshold_float\": 123,\n \"threshold_string\": \"<string>\",\n \"window_size_days\": 183,\n \"window_size_runs\": 5000,\n \"match_value\": \"<string>\"\n }\n ],\n \"channels\": [\n {\n \"config\": {}\n }\n ]\n}")
.asString();require 'uri'
require 'net/http'
url = URI("https://api.coval.dev/v1/alerts/{alert_id}")
http = Net::HTTP.new(url.host, url.port)
http.use_ssl = true
request = Net::HTTP::Patch.new(url)
request["X-API-Key"] = '<api-key>'
request["Content-Type"] = 'application/json'
request.body = "{\n \"name\": \"<string>\",\n \"description\": \"<string>\",\n \"evaluation_type\": \"ON_RUN_COMPLETE\",\n \"cooldown_seconds\": 43200,\n \"custom_message_template\": \"<string>\",\n \"agent_ids\": [\n \"<string>\"\n ],\n \"required_tags\": [\n \"<string>\"\n ],\n \"scheduled_run_ids\": [\n \"<string>\"\n ],\n \"conditions\": [\n {\n \"metric_id\": \"<string>\",\n \"threshold_float\": 123,\n \"threshold_string\": \"<string>\",\n \"window_size_days\": 183,\n \"window_size_runs\": 5000,\n \"match_value\": \"<string>\"\n }\n ],\n \"channels\": [\n {\n \"config\": {}\n }\n ]\n}"
response = http.request(request)
puts response.read_body{
"ulid": "01HZ0EXAMPLE00000000000000",
"name": "Latency SLA Alert",
"evaluation_type": "ON_RUN_COMPLETE",
"cooldown_seconds": 43200,
"trigger_count": 123,
"conditions": [
{
"ulid": "<string>",
"metric_id": "<string>",
"threshold_float": 123,
"threshold_string": "<string>",
"window_size_days": 183,
"window_size_runs": 5000,
"match_value": "<string>"
}
],
"channels": [
{
"ulid": "<string>",
"config": {}
}
],
"create_time": "2023-11-07T05:31:56Z",
"update_time": "2023-11-07T05:31:56Z",
"description": "",
"custom_message_template": "<string>",
"agent_ids": [
"<string>"
],
"required_tags": [
"<string>"
],
"scheduled_run_ids": [
"<string>"
],
"last_triggered_at": "2023-11-07T05:31:56Z"
}{
"error": {
"code": "INVALID_ARGUMENT",
"message": "Invalid request body",
"details": [
{
"field": "conditions",
"description": "Value error, List should have at least 1 item after validation"
}
]
}
}{
"error": {
"code": "UNAUTHENTICATED",
"message": "Authentication failed",
"details": [
{
"field": "X-API-Key",
"description": "Invalid or missing API key"
}
]
}
}{
"error": {
"code": "PERMISSION_DENIED",
"message": "Insufficient permissions",
"details": [
{
"field": "permissions",
"description": "Required scope: alerts:read"
}
]
}
}{
"error": {
"code": "NOT_FOUND",
"message": "Alert not found",
"details": [
{
"field": "alert_id",
"description": "Alert '01HZ0EXAMPLE00000000000000' not found"
}
]
}
}{
"error": {
"message": "<string>",
"details": [
{
"field": "<string>",
"description": "<string>"
}
]
}
}{
"error": {
"code": "INTERNAL",
"message": "Internal server error",
"details": [
{
"description": "An unexpected error occurred"
}
]
}
}Authorizations
API key for authentication
Path Parameters
Alert ULID
Pattern:
^[0-9A-Z]{26}$Body
application/json
Maximum string length:
200Maximum string length:
2000When the alert evaluates
Available options:
ON_RUN_COMPLETE Which runs the alert applies to
Available options:
ALL, MONITORING, SIMULATION How multiple conditions are combined (AND vs OR)
Available options:
ALL, ANY Required range:
0 <= x <= 86400Replaces all existing conditions
Minimum array length:
1Show child attributes
Show child attributes
Replaces all existing channels
Show child attributes
Show child attributes
Response
Alert updated
Alert ULID
Pattern:
^[0-9A-Z]{26}$Example:
"01HZ0EXAMPLE00000000000000"
Human-readable alert name
Maximum string length:
200Example:
"Latency SLA Alert"
Alert status
Available options:
ACTIVE, DELETED When the alert evaluates
Available options:
ON_RUN_COMPLETE Which runs the alert applies to
Available options:
ALL, MONITORING, SIMULATION How multiple conditions are combined (AND vs OR)
Available options:
ALL, ANY Minimum seconds between triggers
Required range:
0 <= x <= 86400Number of times this alert has triggered
Evaluation conditions
Show child attributes
Show child attributes
Notification channels
Show child attributes
Show child attributes
Creation timestamp
Last update timestamp
Optional description
Custom notification message template
Maximum string length:
5000Restrict to specific agent IDs
Restrict to runs with these tags
Restrict to runs originating from these scheduled runs
Last trigger timestamp
Was this page helpful?
⌘I