dashboard alert rules
Update dashboard alert rules id
Requires scopes: reports:write
PATCH
/
api
/
dashboard-alert-rules
/
{id}
Update dashboard alert rules id
curl --request PATCH \
--url https://evalgate.com/api/dashboard-alert-rules/{id} \
--header 'Authorization: Bearer <token>' \
--header 'Content-Type: application/json' \
--data '
{
"name": "<string>",
"operator": "gte",
"threshold": {
"value": 123,
"upperValue": 123,
"forConsecutive": 123,
"resolveAfterConsecutive": 123
},
"metricDefinitionId": "<string>",
"ruleKey": "<string>",
"evaluationWindow": {
"type": "relative",
"lookbackSeconds": 123,
"timezone": "<string>"
},
"severity": "critical",
"enabled": false,
"dedupeWindowSeconds": 123,
"deliveryConfig": {
"webhook": false,
"notification": false
}
}
'import requests
url = "https://evalgate.com/api/dashboard-alert-rules/{id}"
payload = {
"name": "<string>",
"operator": "gte",
"threshold": {
"value": 123,
"upperValue": 123,
"forConsecutive": 123,
"resolveAfterConsecutive": 123
},
"metricDefinitionId": "<string>",
"ruleKey": "<string>",
"evaluationWindow": {
"type": "relative",
"lookbackSeconds": 123,
"timezone": "<string>"
},
"severity": "critical",
"enabled": False,
"dedupeWindowSeconds": 123,
"deliveryConfig": {
"webhook": False,
"notification": False
}
}
headers = {
"Authorization": "Bearer <token>",
"Content-Type": "application/json"
}
response = requests.patch(url, json=payload, headers=headers)
print(response.text)const options = {
method: 'PATCH',
headers: {Authorization: 'Bearer <token>', 'Content-Type': 'application/json'},
body: JSON.stringify({
name: '<string>',
operator: 'gte',
threshold: {value: 123, upperValue: 123, forConsecutive: 123, resolveAfterConsecutive: 123},
metricDefinitionId: '<string>',
ruleKey: '<string>',
evaluationWindow: {type: 'relative', lookbackSeconds: 123, timezone: '<string>'},
severity: 'critical',
enabled: false,
dedupeWindowSeconds: 123,
deliveryConfig: {webhook: false, notification: false}
})
};
fetch('https://evalgate.com/api/dashboard-alert-rules/{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://evalgate.com/api/dashboard-alert-rules/{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>',
'operator' => 'gte',
'threshold' => [
'value' => 123,
'upperValue' => 123,
'forConsecutive' => 123,
'resolveAfterConsecutive' => 123
],
'metricDefinitionId' => '<string>',
'ruleKey' => '<string>',
'evaluationWindow' => [
'type' => 'relative',
'lookbackSeconds' => 123,
'timezone' => '<string>'
],
'severity' => 'critical',
'enabled' => false,
'dedupeWindowSeconds' => 123,
'deliveryConfig' => [
'webhook' => false,
'notification' => false
]
]),
CURLOPT_HTTPHEADER => [
"Authorization: Bearer <token>",
"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://evalgate.com/api/dashboard-alert-rules/{id}"
payload := strings.NewReader("{\n \"name\": \"<string>\",\n \"operator\": \"gte\",\n \"threshold\": {\n \"value\": 123,\n \"upperValue\": 123,\n \"forConsecutive\": 123,\n \"resolveAfterConsecutive\": 123\n },\n \"metricDefinitionId\": \"<string>\",\n \"ruleKey\": \"<string>\",\n \"evaluationWindow\": {\n \"type\": \"relative\",\n \"lookbackSeconds\": 123,\n \"timezone\": \"<string>\"\n },\n \"severity\": \"critical\",\n \"enabled\": false,\n \"dedupeWindowSeconds\": 123,\n \"deliveryConfig\": {\n \"webhook\": false,\n \"notification\": false\n }\n}")
req, _ := http.NewRequest("PATCH", 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))
}HttpResponse<String> response = Unirest.patch("https://evalgate.com/api/dashboard-alert-rules/{id}")
.header("Authorization", "Bearer <token>")
.header("Content-Type", "application/json")
.body("{\n \"name\": \"<string>\",\n \"operator\": \"gte\",\n \"threshold\": {\n \"value\": 123,\n \"upperValue\": 123,\n \"forConsecutive\": 123,\n \"resolveAfterConsecutive\": 123\n },\n \"metricDefinitionId\": \"<string>\",\n \"ruleKey\": \"<string>\",\n \"evaluationWindow\": {\n \"type\": \"relative\",\n \"lookbackSeconds\": 123,\n \"timezone\": \"<string>\"\n },\n \"severity\": \"critical\",\n \"enabled\": false,\n \"dedupeWindowSeconds\": 123,\n \"deliveryConfig\": {\n \"webhook\": false,\n \"notification\": false\n }\n}")
.asString();require 'uri'
require 'net/http'
url = URI("https://evalgate.com/api/dashboard-alert-rules/{id}")
http = Net::HTTP.new(url.host, url.port)
http.use_ssl = true
request = Net::HTTP::Patch.new(url)
request["Authorization"] = 'Bearer <token>'
request["Content-Type"] = 'application/json'
request.body = "{\n \"name\": \"<string>\",\n \"operator\": \"gte\",\n \"threshold\": {\n \"value\": 123,\n \"upperValue\": 123,\n \"forConsecutive\": 123,\n \"resolveAfterConsecutive\": 123\n },\n \"metricDefinitionId\": \"<string>\",\n \"ruleKey\": \"<string>\",\n \"evaluationWindow\": {\n \"type\": \"relative\",\n \"lookbackSeconds\": 123,\n \"timezone\": \"<string>\"\n },\n \"severity\": \"critical\",\n \"enabled\": false,\n \"dedupeWindowSeconds\": 123,\n \"deliveryConfig\": {\n \"webhook\": false,\n \"notification\": false\n }\n}"
response = http.request(request)
puts response.read_body{
"rule": {
"id": "<string>",
"organizationId": "3c90c3cc-0d44-4b50-8888-8dd25736052a",
"ruleKey": "<string>",
"name": "<string>",
"ownerId": "<string>",
"currentVersionId": "<string>",
"enabled": true,
"createdAt": "2023-11-07T05:31:56Z",
"updatedAt": "2023-11-07T05:31:56Z"
},
"version": {
"id": "<string>",
"organizationId": "3c90c3cc-0d44-4b50-8888-8dd25736052a",
"alertRuleId": "<string>",
"version": 123,
"metricDefinitionId": "<string>",
"operator": "<string>",
"thresholdJson": {
"value": 123,
"forConsecutive": 123,
"resolveAfterConsecutive": 123,
"upperValue": 123
},
"evaluationWindow": {
"type": "relative",
"timezone": "<string>",
"lookbackSeconds": 123
},
"dedupeWindowSeconds": 123,
"severity": "<string>",
"deliveryConfig": {
"webhook": true,
"notification": true
},
"contentHash": "<string>",
"createdBy": "<string>",
"createdAt": "2023-11-07T05:31:56Z"
}
}{
"error": {
"code": "UNAUTHORIZED",
"message": "<string>",
"details": "<unknown>",
"requestId": "3c90c3cc-0d44-4b50-8888-8dd25736052a",
"redaction": {
"applied": true,
"fieldCount": 1,
"secretCount": 1
}
}
}{
"error": {
"code": "UNAUTHORIZED",
"message": "<string>",
"details": "<unknown>",
"requestId": "3c90c3cc-0d44-4b50-8888-8dd25736052a",
"redaction": {
"applied": true,
"fieldCount": 1,
"secretCount": 1
}
}
}{
"error": {
"code": "UNAUTHORIZED",
"message": "<string>",
"details": "<unknown>",
"requestId": "3c90c3cc-0d44-4b50-8888-8dd25736052a",
"redaction": {
"applied": true,
"fieldCount": 1,
"secretCount": 1
}
}
}{
"error": {
"code": "UNAUTHORIZED",
"message": "<string>",
"details": "<unknown>",
"requestId": "3c90c3cc-0d44-4b50-8888-8dd25736052a",
"redaction": {
"applied": true,
"fieldCount": 1,
"secretCount": 1
}
}
}{
"error": {
"code": "UNAUTHORIZED",
"message": "<string>",
"details": "<unknown>",
"requestId": "3c90c3cc-0d44-4b50-8888-8dd25736052a",
"redaction": {
"applied": true,
"fieldCount": 1,
"secretCount": 1
}
}
}{
"error": {
"code": "UNAUTHORIZED",
"message": "<string>",
"details": "<unknown>",
"requestId": "3c90c3cc-0d44-4b50-8888-8dd25736052a",
"redaction": {
"applied": true,
"fieldCount": 1,
"secretCount": 1
}
}
}{
"error": {
"code": "UNAUTHORIZED",
"message": "<string>",
"details": "<unknown>",
"requestId": "3c90c3cc-0d44-4b50-8888-8dd25736052a",
"redaction": {
"applied": true,
"fieldCount": 1,
"secretCount": 1
}
}
}{
"error": {
"code": "UNAUTHORIZED",
"message": "<string>",
"details": "<unknown>",
"requestId": "3c90c3cc-0d44-4b50-8888-8dd25736052a",
"redaction": {
"applied": true,
"fieldCount": 1,
"secretCount": 1
}
}
}Authorizations
Organization-scoped EvalGate API key. Discover the supported agent scopes at /.well-known/oauth-protected-resource. Per-operation grants are listed in x-evalgate-required-scopes; OpenAPI bearer security requirement arrays remain empty as required for non-OAuth schemes.
Path Parameters
Body
application/json
operator
Option 1 · enum<string>Option 2 · enum<string>Option 3 · enum<string>Option 4 · enum<string>Option 5 · enum<string>Option 6 · enum<string>
required
Available options:
gte Show child attributes
Show child attributes
- Option 1
- Option 2
Show child attributes
Show child attributes
Available options:
critical Available options:
false Show child attributes
Show child attributes
⌘I
Update dashboard alert rules id
curl --request PATCH \
--url https://evalgate.com/api/dashboard-alert-rules/{id} \
--header 'Authorization: Bearer <token>' \
--header 'Content-Type: application/json' \
--data '
{
"name": "<string>",
"operator": "gte",
"threshold": {
"value": 123,
"upperValue": 123,
"forConsecutive": 123,
"resolveAfterConsecutive": 123
},
"metricDefinitionId": "<string>",
"ruleKey": "<string>",
"evaluationWindow": {
"type": "relative",
"lookbackSeconds": 123,
"timezone": "<string>"
},
"severity": "critical",
"enabled": false,
"dedupeWindowSeconds": 123,
"deliveryConfig": {
"webhook": false,
"notification": false
}
}
'import requests
url = "https://evalgate.com/api/dashboard-alert-rules/{id}"
payload = {
"name": "<string>",
"operator": "gte",
"threshold": {
"value": 123,
"upperValue": 123,
"forConsecutive": 123,
"resolveAfterConsecutive": 123
},
"metricDefinitionId": "<string>",
"ruleKey": "<string>",
"evaluationWindow": {
"type": "relative",
"lookbackSeconds": 123,
"timezone": "<string>"
},
"severity": "critical",
"enabled": False,
"dedupeWindowSeconds": 123,
"deliveryConfig": {
"webhook": False,
"notification": False
}
}
headers = {
"Authorization": "Bearer <token>",
"Content-Type": "application/json"
}
response = requests.patch(url, json=payload, headers=headers)
print(response.text)const options = {
method: 'PATCH',
headers: {Authorization: 'Bearer <token>', 'Content-Type': 'application/json'},
body: JSON.stringify({
name: '<string>',
operator: 'gte',
threshold: {value: 123, upperValue: 123, forConsecutive: 123, resolveAfterConsecutive: 123},
metricDefinitionId: '<string>',
ruleKey: '<string>',
evaluationWindow: {type: 'relative', lookbackSeconds: 123, timezone: '<string>'},
severity: 'critical',
enabled: false,
dedupeWindowSeconds: 123,
deliveryConfig: {webhook: false, notification: false}
})
};
fetch('https://evalgate.com/api/dashboard-alert-rules/{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://evalgate.com/api/dashboard-alert-rules/{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>',
'operator' => 'gte',
'threshold' => [
'value' => 123,
'upperValue' => 123,
'forConsecutive' => 123,
'resolveAfterConsecutive' => 123
],
'metricDefinitionId' => '<string>',
'ruleKey' => '<string>',
'evaluationWindow' => [
'type' => 'relative',
'lookbackSeconds' => 123,
'timezone' => '<string>'
],
'severity' => 'critical',
'enabled' => false,
'dedupeWindowSeconds' => 123,
'deliveryConfig' => [
'webhook' => false,
'notification' => false
]
]),
CURLOPT_HTTPHEADER => [
"Authorization: Bearer <token>",
"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://evalgate.com/api/dashboard-alert-rules/{id}"
payload := strings.NewReader("{\n \"name\": \"<string>\",\n \"operator\": \"gte\",\n \"threshold\": {\n \"value\": 123,\n \"upperValue\": 123,\n \"forConsecutive\": 123,\n \"resolveAfterConsecutive\": 123\n },\n \"metricDefinitionId\": \"<string>\",\n \"ruleKey\": \"<string>\",\n \"evaluationWindow\": {\n \"type\": \"relative\",\n \"lookbackSeconds\": 123,\n \"timezone\": \"<string>\"\n },\n \"severity\": \"critical\",\n \"enabled\": false,\n \"dedupeWindowSeconds\": 123,\n \"deliveryConfig\": {\n \"webhook\": false,\n \"notification\": false\n }\n}")
req, _ := http.NewRequest("PATCH", 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))
}HttpResponse<String> response = Unirest.patch("https://evalgate.com/api/dashboard-alert-rules/{id}")
.header("Authorization", "Bearer <token>")
.header("Content-Type", "application/json")
.body("{\n \"name\": \"<string>\",\n \"operator\": \"gte\",\n \"threshold\": {\n \"value\": 123,\n \"upperValue\": 123,\n \"forConsecutive\": 123,\n \"resolveAfterConsecutive\": 123\n },\n \"metricDefinitionId\": \"<string>\",\n \"ruleKey\": \"<string>\",\n \"evaluationWindow\": {\n \"type\": \"relative\",\n \"lookbackSeconds\": 123,\n \"timezone\": \"<string>\"\n },\n \"severity\": \"critical\",\n \"enabled\": false,\n \"dedupeWindowSeconds\": 123,\n \"deliveryConfig\": {\n \"webhook\": false,\n \"notification\": false\n }\n}")
.asString();require 'uri'
require 'net/http'
url = URI("https://evalgate.com/api/dashboard-alert-rules/{id}")
http = Net::HTTP.new(url.host, url.port)
http.use_ssl = true
request = Net::HTTP::Patch.new(url)
request["Authorization"] = 'Bearer <token>'
request["Content-Type"] = 'application/json'
request.body = "{\n \"name\": \"<string>\",\n \"operator\": \"gte\",\n \"threshold\": {\n \"value\": 123,\n \"upperValue\": 123,\n \"forConsecutive\": 123,\n \"resolveAfterConsecutive\": 123\n },\n \"metricDefinitionId\": \"<string>\",\n \"ruleKey\": \"<string>\",\n \"evaluationWindow\": {\n \"type\": \"relative\",\n \"lookbackSeconds\": 123,\n \"timezone\": \"<string>\"\n },\n \"severity\": \"critical\",\n \"enabled\": false,\n \"dedupeWindowSeconds\": 123,\n \"deliveryConfig\": {\n \"webhook\": false,\n \"notification\": false\n }\n}"
response = http.request(request)
puts response.read_body{
"rule": {
"id": "<string>",
"organizationId": "3c90c3cc-0d44-4b50-8888-8dd25736052a",
"ruleKey": "<string>",
"name": "<string>",
"ownerId": "<string>",
"currentVersionId": "<string>",
"enabled": true,
"createdAt": "2023-11-07T05:31:56Z",
"updatedAt": "2023-11-07T05:31:56Z"
},
"version": {
"id": "<string>",
"organizationId": "3c90c3cc-0d44-4b50-8888-8dd25736052a",
"alertRuleId": "<string>",
"version": 123,
"metricDefinitionId": "<string>",
"operator": "<string>",
"thresholdJson": {
"value": 123,
"forConsecutive": 123,
"resolveAfterConsecutive": 123,
"upperValue": 123
},
"evaluationWindow": {
"type": "relative",
"timezone": "<string>",
"lookbackSeconds": 123
},
"dedupeWindowSeconds": 123,
"severity": "<string>",
"deliveryConfig": {
"webhook": true,
"notification": true
},
"contentHash": "<string>",
"createdBy": "<string>",
"createdAt": "2023-11-07T05:31:56Z"
}
}{
"error": {
"code": "UNAUTHORIZED",
"message": "<string>",
"details": "<unknown>",
"requestId": "3c90c3cc-0d44-4b50-8888-8dd25736052a",
"redaction": {
"applied": true,
"fieldCount": 1,
"secretCount": 1
}
}
}{
"error": {
"code": "UNAUTHORIZED",
"message": "<string>",
"details": "<unknown>",
"requestId": "3c90c3cc-0d44-4b50-8888-8dd25736052a",
"redaction": {
"applied": true,
"fieldCount": 1,
"secretCount": 1
}
}
}{
"error": {
"code": "UNAUTHORIZED",
"message": "<string>",
"details": "<unknown>",
"requestId": "3c90c3cc-0d44-4b50-8888-8dd25736052a",
"redaction": {
"applied": true,
"fieldCount": 1,
"secretCount": 1
}
}
}{
"error": {
"code": "UNAUTHORIZED",
"message": "<string>",
"details": "<unknown>",
"requestId": "3c90c3cc-0d44-4b50-8888-8dd25736052a",
"redaction": {
"applied": true,
"fieldCount": 1,
"secretCount": 1
}
}
}{
"error": {
"code": "UNAUTHORIZED",
"message": "<string>",
"details": "<unknown>",
"requestId": "3c90c3cc-0d44-4b50-8888-8dd25736052a",
"redaction": {
"applied": true,
"fieldCount": 1,
"secretCount": 1
}
}
}{
"error": {
"code": "UNAUTHORIZED",
"message": "<string>",
"details": "<unknown>",
"requestId": "3c90c3cc-0d44-4b50-8888-8dd25736052a",
"redaction": {
"applied": true,
"fieldCount": 1,
"secretCount": 1
}
}
}{
"error": {
"code": "UNAUTHORIZED",
"message": "<string>",
"details": "<unknown>",
"requestId": "3c90c3cc-0d44-4b50-8888-8dd25736052a",
"redaction": {
"applied": true,
"fieldCount": 1,
"secretCount": 1
}
}
}{
"error": {
"code": "UNAUTHORIZED",
"message": "<string>",
"details": "<unknown>",
"requestId": "3c90c3cc-0d44-4b50-8888-8dd25736052a",
"redaction": {
"applied": true,
"fieldCount": 1,
"secretCount": 1
}
}
}