Update case fields
curl --request PUT \
--url https://api.coralogix.com/mgmt/openapi/5/cases/cases/v1/{id} \
--header 'Authorization: <api-key>' \
--header 'Content-Type: application/json' \
--data '
{
"resolutionReason": "False alarm",
"title": "Database connection investigation"
}
'import requests
url = "https://api.coralogix.com/mgmt/openapi/5/cases/cases/v1/{id}"
payload = {
"resolutionReason": "False alarm",
"title": "Database connection investigation"
}
headers = {
"Authorization": "<api-key>",
"Content-Type": "application/json"
}
response = requests.put(url, json=payload, headers=headers)
print(response.text)const options = {
method: 'PUT',
headers: {Authorization: '<api-key>', 'Content-Type': 'application/json'},
body: JSON.stringify({resolutionReason: 'False alarm', title: 'Database connection investigation'})
};
fetch('https://api.coralogix.com/mgmt/openapi/5/cases/cases/v1/{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.coralogix.com/mgmt/openapi/5/cases/cases/v1/{id}",
CURLOPT_RETURNTRANSFER => true,
CURLOPT_ENCODING => "",
CURLOPT_MAXREDIRS => 10,
CURLOPT_TIMEOUT => 30,
CURLOPT_HTTP_VERSION => CURL_HTTP_VERSION_1_1,
CURLOPT_CUSTOMREQUEST => "PUT",
CURLOPT_POSTFIELDS => json_encode([
'resolutionReason' => 'False alarm',
'title' => 'Database connection investigation'
]),
CURLOPT_HTTPHEADER => [
"Authorization: <api-key>",
"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.coralogix.com/mgmt/openapi/5/cases/cases/v1/{id}"
payload := strings.NewReader("{\n \"resolutionReason\": \"False alarm\",\n \"title\": \"Database connection investigation\"\n}")
req, _ := http.NewRequest("PUT", url, payload)
req.Header.Add("Authorization", "<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.put("https://api.coralogix.com/mgmt/openapi/5/cases/cases/v1/{id}")
.header("Authorization", "<api-key>")
.header("Content-Type", "application/json")
.body("{\n \"resolutionReason\": \"False alarm\",\n \"title\": \"Database connection investigation\"\n}")
.asString();require 'uri'
require 'net/http'
url = URI("https://api.coralogix.com/mgmt/openapi/5/cases/cases/v1/{id}")
http = Net::HTTP.new(url.host, url.port)
http.use_ssl = true
request = Net::HTTP::Put.new(url)
request["Authorization"] = '<api-key>'
request["Content-Type"] = 'application/json'
request.body = "{\n \"resolutionReason\": \"False alarm\",\n \"title\": \"Database connection investigation\"\n}"
response = http.request(request)
puts response.read_body{
"case": {
"category": "CASE_CATEGORY_AVAILABILITY",
"createTime": "2025-09-22T10:30:00.000Z",
"groupings": [
{
"key": "service",
"value": "payments"
}
],
"id": "3f166e9f-3c88-4af2-b52e-138f339dab3e",
"impactedEntities": [
{
"apmService": {
"language": "go",
"name": "payments-api"
},
"apmDatabase": {
"name": "orders-db",
"system": "postgresql"
}
}
],
"labels": [
{
"key": "team",
"value": "backend"
}
],
"priority": "CASE_PRIORITY_P2",
"status": "CASE_STATUS_ACKNOWLEDGED",
"title": "Database outage investigation",
"acknowledgeTime": "2023-11-07T05:31:56Z",
"aiSummary": "<string>",
"assignee": {
"userId": "3af152ee-9eaf-4803-87f1-23c5fb2fbaa0"
},
"caseIndicators": {
"alertIndicators": [
{
"alertId": "f56645c5-9cd4-4b9f-961f-4f852d8835a0",
"alertVersions": [
"1eae3615-79e7-4b54-88e0-6a77def653bf",
"2fbf4726-8af8-5c65-99f1-7b88ef764c0g"
],
"groupingType": "GROUPING_TYPE_COMPOSITE_ALERT",
"latestAlertVersion": "1eae3615-79e7-4b54-88e0-6a77def653bf",
"permutations": [
{
"permutation": {
"service": "payments",
"cluster": "prod"
}
},
{
"permutation": {
"service": "billing",
"cluster": "prod"
}
}
],
"priority": "ALERT_PRIORITY_P2",
"state": "ALERT_INDICATOR_STATE_TRIGGERED",
"triggerTime": "2025-09-22T10:30:00.000Z",
"customDataprimeQueries": [
"source logs | filter $d.severity == 'ERROR'"
],
"resolveTime": "2025-09-22T11:05:00.000Z",
"resolveWithSignal": true,
"suppression": {
"activeSuppressionRules": {
"suppressionRuleIds": [
"1eae3615-79e7-4b54-88e0-6a77def653bf",
"2fbf4726-8af8-5c65-99f1-7b88ef764c0e"
]
},
"alertDefinitionMuted": {},
"suppressedTime": "2025-09-22T10:30:00.000Z"
}
}
],
"genericIndicators": [
{
"externalId": "et-issue-8827",
"id": "f56645c5-9cd4-4b9f-961f-4f852d8835a0",
"indicatorType": "GENERIC_INDICATOR_TYPE_ERROR_TRACKING",
"lastTriggeredAt": "2025-09-22T10:30:00.000Z",
"priority": "INDICATOR_PRIORITY_P2",
"status": "GENERIC_INDICATOR_STATUS_TRIGGERED",
"entityLinks": [
{
"url": "https://app.coralogix.com/error-tracking/issues/abc123"
}
],
"labels": [
{
"key": "service",
"value": "auth"
}
],
"lastResolvedAt": "2025-09-22T11:05:00.000Z"
}
],
"prometheusAlertIndicators": [
{
"alertGroupId": "5d41402abc4b2a76b9719d911017c592",
"alerts": [
{
"alertGroupId": "5d41402abc4b2a76b9719d911017c592",
"alertName": "HighRequestLatency",
"annotations": {},
"createdAt": "2025-09-22T10:30:00.000Z",
"fingerprint": "a1b2c3d4e5f6a7b8",
"generatorUrl": "https://prometheus.example.com/graph?g0.expr=...",
"labels": {},
"priority": "INDICATOR_PRIORITY_P2",
"status": {
"triggered": {
"triggeredAt": "2025-09-22T10:30:00.000Z"
},
"resolved": {
"resolvedAt": "2025-09-22T11:05:00.000Z",
"triggeredAt": "2025-09-22T10:30:00.000Z"
}
},
"updatedAt": "2025-09-22T11:05:00.000Z",
"query": {
"promql": "histogram_quantile(0.95, rate(http_request_duration_seconds_bucket[5m])) > 1"
}
}
],
"externalUrl": "https://alertmanager.example.com",
"groupLabels": {},
"priority": "INDICATOR_PRIORITY_P2",
"receivedAt": "2025-09-22T10:30:00.000Z",
"receiver": "webhook-coralogix",
"status": {
"triggered": {
"triggeredAt": "2025-09-22T10:30:00.000Z"
},
"resolved": {
"resolvedAt": "2025-09-22T11:05:00.000Z",
"triggeredAt": "2025-09-22T10:30:00.000Z"
}
},
"updatedAt": "2025-09-22T11:05:00.000Z"
}
]
},
"duration": "<string>",
"kpiBreaches": {
"breachedKpis": [
{
"kpi_type": "KPI_TYPE_TIME_TO_ACKNOWLEDGE",
"case_priority": "CASE_PRIORITY_P1",
"resolution_breached_at": "2025-09-22T11:00:00.000Z"
}
]
},
"ollyAnalysis": {
"completedAt": "2025-09-22T10:30:00.000Z",
"payload": {
"generatedAt": "2025-09-22T10:30:00.000Z",
"investigationSummary": "Latency spike on checkout-service correlates with a deploy of v1.42 and elevated DB pool saturation.",
"remediationRecommendations": [
"Roll back checkout-service to v1.41",
"Increase orders Postgres pool size to 200"
],
"rootCause": "Connection-pool exhaustion on the orders Postgres instance.",
"rootCauseConfidence": "OLLY_ANALYSIS_ROOT_CAUSE_CONFIDENCE_HIGH"
},
"status": "STATUS_OK"
},
"priorityDetails": {
"override": "CASE_PRIORITY_UNSPECIFIED",
"system": "CASE_PRIORITY_UNSPECIFIED"
},
"readableId": "CASE-123",
"resolutionDetails": {
"reason": "Case was not applicable.",
"resolveTime": "2025-09-22T11:15:00.000Z",
"resolvedBy": {
"system": {},
"apiKey": {},
"cxUser": {},
"microsoftTeams": {},
"pagerDuty": {},
"prometheusAlertManager": {},
"serviceNow": {},
"slack": {}
}
},
"updateTime": "2023-11-07T05:31:56Z"
}
}{
"code": 349,
"message": "<string>"
}{
"code": 349,
"message": "<string>"
}{
"code": 349,
"message": "<string>"
}Cases Service
Update case fields
Apply a partial update (patch) to a case.
Requires the following permissions:
case:Update
Update case fields
curl --request PUT \
--url https://api.coralogix.com/mgmt/openapi/5/cases/cases/v1/{id} \
--header 'Authorization: <api-key>' \
--header 'Content-Type: application/json' \
--data '
{
"resolutionReason": "False alarm",
"title": "Database connection investigation"
}
'import requests
url = "https://api.coralogix.com/mgmt/openapi/5/cases/cases/v1/{id}"
payload = {
"resolutionReason": "False alarm",
"title": "Database connection investigation"
}
headers = {
"Authorization": "<api-key>",
"Content-Type": "application/json"
}
response = requests.put(url, json=payload, headers=headers)
print(response.text)const options = {
method: 'PUT',
headers: {Authorization: '<api-key>', 'Content-Type': 'application/json'},
body: JSON.stringify({resolutionReason: 'False alarm', title: 'Database connection investigation'})
};
fetch('https://api.coralogix.com/mgmt/openapi/5/cases/cases/v1/{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.coralogix.com/mgmt/openapi/5/cases/cases/v1/{id}",
CURLOPT_RETURNTRANSFER => true,
CURLOPT_ENCODING => "",
CURLOPT_MAXREDIRS => 10,
CURLOPT_TIMEOUT => 30,
CURLOPT_HTTP_VERSION => CURL_HTTP_VERSION_1_1,
CURLOPT_CUSTOMREQUEST => "PUT",
CURLOPT_POSTFIELDS => json_encode([
'resolutionReason' => 'False alarm',
'title' => 'Database connection investigation'
]),
CURLOPT_HTTPHEADER => [
"Authorization: <api-key>",
"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.coralogix.com/mgmt/openapi/5/cases/cases/v1/{id}"
payload := strings.NewReader("{\n \"resolutionReason\": \"False alarm\",\n \"title\": \"Database connection investigation\"\n}")
req, _ := http.NewRequest("PUT", url, payload)
req.Header.Add("Authorization", "<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.put("https://api.coralogix.com/mgmt/openapi/5/cases/cases/v1/{id}")
.header("Authorization", "<api-key>")
.header("Content-Type", "application/json")
.body("{\n \"resolutionReason\": \"False alarm\",\n \"title\": \"Database connection investigation\"\n}")
.asString();require 'uri'
require 'net/http'
url = URI("https://api.coralogix.com/mgmt/openapi/5/cases/cases/v1/{id}")
http = Net::HTTP.new(url.host, url.port)
http.use_ssl = true
request = Net::HTTP::Put.new(url)
request["Authorization"] = '<api-key>'
request["Content-Type"] = 'application/json'
request.body = "{\n \"resolutionReason\": \"False alarm\",\n \"title\": \"Database connection investigation\"\n}"
response = http.request(request)
puts response.read_body{
"case": {
"category": "CASE_CATEGORY_AVAILABILITY",
"createTime": "2025-09-22T10:30:00.000Z",
"groupings": [
{
"key": "service",
"value": "payments"
}
],
"id": "3f166e9f-3c88-4af2-b52e-138f339dab3e",
"impactedEntities": [
{
"apmService": {
"language": "go",
"name": "payments-api"
},
"apmDatabase": {
"name": "orders-db",
"system": "postgresql"
}
}
],
"labels": [
{
"key": "team",
"value": "backend"
}
],
"priority": "CASE_PRIORITY_P2",
"status": "CASE_STATUS_ACKNOWLEDGED",
"title": "Database outage investigation",
"acknowledgeTime": "2023-11-07T05:31:56Z",
"aiSummary": "<string>",
"assignee": {
"userId": "3af152ee-9eaf-4803-87f1-23c5fb2fbaa0"
},
"caseIndicators": {
"alertIndicators": [
{
"alertId": "f56645c5-9cd4-4b9f-961f-4f852d8835a0",
"alertVersions": [
"1eae3615-79e7-4b54-88e0-6a77def653bf",
"2fbf4726-8af8-5c65-99f1-7b88ef764c0g"
],
"groupingType": "GROUPING_TYPE_COMPOSITE_ALERT",
"latestAlertVersion": "1eae3615-79e7-4b54-88e0-6a77def653bf",
"permutations": [
{
"permutation": {
"service": "payments",
"cluster": "prod"
}
},
{
"permutation": {
"service": "billing",
"cluster": "prod"
}
}
],
"priority": "ALERT_PRIORITY_P2",
"state": "ALERT_INDICATOR_STATE_TRIGGERED",
"triggerTime": "2025-09-22T10:30:00.000Z",
"customDataprimeQueries": [
"source logs | filter $d.severity == 'ERROR'"
],
"resolveTime": "2025-09-22T11:05:00.000Z",
"resolveWithSignal": true,
"suppression": {
"activeSuppressionRules": {
"suppressionRuleIds": [
"1eae3615-79e7-4b54-88e0-6a77def653bf",
"2fbf4726-8af8-5c65-99f1-7b88ef764c0e"
]
},
"alertDefinitionMuted": {},
"suppressedTime": "2025-09-22T10:30:00.000Z"
}
}
],
"genericIndicators": [
{
"externalId": "et-issue-8827",
"id": "f56645c5-9cd4-4b9f-961f-4f852d8835a0",
"indicatorType": "GENERIC_INDICATOR_TYPE_ERROR_TRACKING",
"lastTriggeredAt": "2025-09-22T10:30:00.000Z",
"priority": "INDICATOR_PRIORITY_P2",
"status": "GENERIC_INDICATOR_STATUS_TRIGGERED",
"entityLinks": [
{
"url": "https://app.coralogix.com/error-tracking/issues/abc123"
}
],
"labels": [
{
"key": "service",
"value": "auth"
}
],
"lastResolvedAt": "2025-09-22T11:05:00.000Z"
}
],
"prometheusAlertIndicators": [
{
"alertGroupId": "5d41402abc4b2a76b9719d911017c592",
"alerts": [
{
"alertGroupId": "5d41402abc4b2a76b9719d911017c592",
"alertName": "HighRequestLatency",
"annotations": {},
"createdAt": "2025-09-22T10:30:00.000Z",
"fingerprint": "a1b2c3d4e5f6a7b8",
"generatorUrl": "https://prometheus.example.com/graph?g0.expr=...",
"labels": {},
"priority": "INDICATOR_PRIORITY_P2",
"status": {
"triggered": {
"triggeredAt": "2025-09-22T10:30:00.000Z"
},
"resolved": {
"resolvedAt": "2025-09-22T11:05:00.000Z",
"triggeredAt": "2025-09-22T10:30:00.000Z"
}
},
"updatedAt": "2025-09-22T11:05:00.000Z",
"query": {
"promql": "histogram_quantile(0.95, rate(http_request_duration_seconds_bucket[5m])) > 1"
}
}
],
"externalUrl": "https://alertmanager.example.com",
"groupLabels": {},
"priority": "INDICATOR_PRIORITY_P2",
"receivedAt": "2025-09-22T10:30:00.000Z",
"receiver": "webhook-coralogix",
"status": {
"triggered": {
"triggeredAt": "2025-09-22T10:30:00.000Z"
},
"resolved": {
"resolvedAt": "2025-09-22T11:05:00.000Z",
"triggeredAt": "2025-09-22T10:30:00.000Z"
}
},
"updatedAt": "2025-09-22T11:05:00.000Z"
}
]
},
"duration": "<string>",
"kpiBreaches": {
"breachedKpis": [
{
"kpi_type": "KPI_TYPE_TIME_TO_ACKNOWLEDGE",
"case_priority": "CASE_PRIORITY_P1",
"resolution_breached_at": "2025-09-22T11:00:00.000Z"
}
]
},
"ollyAnalysis": {
"completedAt": "2025-09-22T10:30:00.000Z",
"payload": {
"generatedAt": "2025-09-22T10:30:00.000Z",
"investigationSummary": "Latency spike on checkout-service correlates with a deploy of v1.42 and elevated DB pool saturation.",
"remediationRecommendations": [
"Roll back checkout-service to v1.41",
"Increase orders Postgres pool size to 200"
],
"rootCause": "Connection-pool exhaustion on the orders Postgres instance.",
"rootCauseConfidence": "OLLY_ANALYSIS_ROOT_CAUSE_CONFIDENCE_HIGH"
},
"status": "STATUS_OK"
},
"priorityDetails": {
"override": "CASE_PRIORITY_UNSPECIFIED",
"system": "CASE_PRIORITY_UNSPECIFIED"
},
"readableId": "CASE-123",
"resolutionDetails": {
"reason": "Case was not applicable.",
"resolveTime": "2025-09-22T11:15:00.000Z",
"resolvedBy": {
"system": {},
"apiKey": {},
"cxUser": {},
"microsoftTeams": {},
"pagerDuty": {},
"prometheusAlertManager": {},
"serviceNow": {},
"slack": {}
}
},
"updateTime": "2023-11-07T05:31:56Z"
}
}{
"code": 349,
"message": "<string>"
}{
"code": 349,
"message": "<string>"
}{
"code": 349,
"message": "<string>"
}Authorizations
API key authentication
Path Parameters
ID of the case to update. Accepts either the case UUID (the id field on a case) or the readable identifier (the readable_id field, e.g. CASE-123).
Required string length:
1 - 64Pattern:
^([0-9a-f]{8}-[0-9a-f]{4}-[0-9a-f]{4}-[0-9a-f]{4}-[0-9a-f]{12}|[A-Z]+-[0-9]+)$Example:
"3f166e9f-3c88-4af2-b52e-138f339dab3e"
Body
application/json
Partial set of fields to update on the case
New case resolution reason. Leading and trailing whitespace is trimmed before the length limits are applied.
Required string length:
1 - 500Pattern:
^[\s\S]*\S[\s\S]*$Example:
"False alarm"
New case title. Leading and trailing whitespace is trimmed before the length limits are applied.
Required string length:
1 - 512Pattern:
^[\s\S]*\S[\s\S]*$Example:
"Database connection investigation"
Response
Response containing the updated case
Updated case
Show child attributes
Show child attributes
Was this page helpful?