List incidents with filters
curl --request POST \
--url https://api.coralogix.com/mgmt/openapi/4/incidents/incidents/v1 \
--header 'Authorization: <api-key>' \
--header 'Content-Type: application/json' \
--data '
{
"filter": {
"applicationName": [
"<string>"
],
"assignee": [
"<string>"
],
"contextualLabels": {},
"displayLabels": {},
"endTime": "2023-11-07T05:31:56Z",
"isMuted": true,
"metaLabels": [
{
"key": "key",
"value": "value"
}
],
"searchQuery": {
"query": "error"
},
"severity": [],
"startTime": "2023-11-07T05:31:56Z",
"state": [],
"status": [],
"subsystemName": [
"<string>"
]
},
"orderBys": [
{}
]
}
'import requests
url = "https://api.coralogix.com/mgmt/openapi/4/incidents/incidents/v1"
payload = {
"filter": {
"applicationName": ["<string>"],
"assignee": ["<string>"],
"contextualLabels": {},
"displayLabels": {},
"endTime": "2023-11-07T05:31:56Z",
"isMuted": True,
"metaLabels": [
{
"key": "key",
"value": "value"
}
],
"searchQuery": { "query": "error" },
"severity": [],
"startTime": "2023-11-07T05:31:56Z",
"state": [],
"status": [],
"subsystemName": ["<string>"]
},
"orderBys": [{}]
}
headers = {
"Authorization": "<api-key>",
"Content-Type": "application/json"
}
response = requests.post(url, json=payload, headers=headers)
print(response.text)const options = {
method: 'POST',
headers: {Authorization: '<api-key>', 'Content-Type': 'application/json'},
body: JSON.stringify({
filter: {
applicationName: ['<string>'],
assignee: ['<string>'],
contextualLabels: {},
displayLabels: {},
endTime: '2023-11-07T05:31:56Z',
isMuted: true,
metaLabels: [{key: 'key', value: 'value'}],
searchQuery: {query: 'error'},
severity: [],
startTime: '2023-11-07T05:31:56Z',
state: [],
status: [],
subsystemName: ['<string>']
},
orderBys: [{}]
})
};
fetch('https://api.coralogix.com/mgmt/openapi/4/incidents/incidents/v1', 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/4/incidents/incidents/v1",
CURLOPT_RETURNTRANSFER => true,
CURLOPT_ENCODING => "",
CURLOPT_MAXREDIRS => 10,
CURLOPT_TIMEOUT => 30,
CURLOPT_HTTP_VERSION => CURL_HTTP_VERSION_1_1,
CURLOPT_CUSTOMREQUEST => "POST",
CURLOPT_POSTFIELDS => json_encode([
'filter' => [
'applicationName' => [
'<string>'
],
'assignee' => [
'<string>'
],
'contextualLabels' => [
],
'displayLabels' => [
],
'endTime' => '2023-11-07T05:31:56Z',
'isMuted' => true,
'metaLabels' => [
[
'key' => 'key',
'value' => 'value'
]
],
'searchQuery' => [
'query' => 'error'
],
'severity' => [
],
'startTime' => '2023-11-07T05:31:56Z',
'state' => [
],
'status' => [
],
'subsystemName' => [
'<string>'
]
],
'orderBys' => [
[
]
]
]),
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/4/incidents/incidents/v1"
payload := strings.NewReader("{\n \"filter\": {\n \"applicationName\": [\n \"<string>\"\n ],\n \"assignee\": [\n \"<string>\"\n ],\n \"contextualLabels\": {},\n \"displayLabels\": {},\n \"endTime\": \"2023-11-07T05:31:56Z\",\n \"isMuted\": true,\n \"metaLabels\": [\n {\n \"key\": \"key\",\n \"value\": \"value\"\n }\n ],\n \"searchQuery\": {\n \"query\": \"error\"\n },\n \"severity\": [],\n \"startTime\": \"2023-11-07T05:31:56Z\",\n \"state\": [],\n \"status\": [],\n \"subsystemName\": [\n \"<string>\"\n ]\n },\n \"orderBys\": [\n {}\n ]\n}")
req, _ := http.NewRequest("POST", 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.post("https://api.coralogix.com/mgmt/openapi/4/incidents/incidents/v1")
.header("Authorization", "<api-key>")
.header("Content-Type", "application/json")
.body("{\n \"filter\": {\n \"applicationName\": [\n \"<string>\"\n ],\n \"assignee\": [\n \"<string>\"\n ],\n \"contextualLabels\": {},\n \"displayLabels\": {},\n \"endTime\": \"2023-11-07T05:31:56Z\",\n \"isMuted\": true,\n \"metaLabels\": [\n {\n \"key\": \"key\",\n \"value\": \"value\"\n }\n ],\n \"searchQuery\": {\n \"query\": \"error\"\n },\n \"severity\": [],\n \"startTime\": \"2023-11-07T05:31:56Z\",\n \"state\": [],\n \"status\": [],\n \"subsystemName\": [\n \"<string>\"\n ]\n },\n \"orderBys\": [\n {}\n ]\n}")
.asString();require 'uri'
require 'net/http'
url = URI("https://api.coralogix.com/mgmt/openapi/4/incidents/incidents/v1")
http = Net::HTTP.new(url.host, url.port)
http.use_ssl = true
request = Net::HTTP::Post.new(url)
request["Authorization"] = '<api-key>'
request["Content-Type"] = 'application/json'
request.body = "{\n \"filter\": {\n \"applicationName\": [\n \"<string>\"\n ],\n \"assignee\": [\n \"<string>\"\n ],\n \"contextualLabels\": {},\n \"displayLabels\": {},\n \"endTime\": \"2023-11-07T05:31:56Z\",\n \"isMuted\": true,\n \"metaLabels\": [\n {\n \"key\": \"key\",\n \"value\": \"value\"\n }\n ],\n \"searchQuery\": {\n \"query\": \"error\"\n },\n \"severity\": [],\n \"startTime\": \"2023-11-07T05:31:56Z\",\n \"state\": [],\n \"status\": [],\n \"subsystemName\": [\n \"<string>\"\n ]\n },\n \"orderBys\": [\n {}\n ]\n}"
response = http.request(request)
puts response.read_body{
"incidents": [
{
"assignments": [
{
"assignedBy": {
"userId": "user_id"
},
"assignedTo": {
"userId": "user_id"
}
}
],
"contextualLabels": {},
"createdAt": "2024-01-01T00:00:00.000Z",
"displayLabels": {},
"duration": "<string>",
"events": [
{
"id": "incident_event_id",
"administrativeEvent": {
"userId": "<string>"
},
"assignment": {
"assignment": {
"assignedBy": {
"userId": "user_id"
},
"assignedTo": {
"userId": "user_id"
}
}
}
}
],
"id": "incident_id",
"lastStateUpdateKey": "last_state_update_key",
"lastStateUpdateTime": "2024-01-01T00:00:00.000Z",
"closedAt": "2024-01-01T00:00:00.000Z",
"description": "incident_description",
"isMuted": false,
"metaLabels": [
{
"key": "key",
"value": "value"
}
],
"name": "incident_name"
}
],
"pagination": {
"totalSize": 100,
"nextPageToken": "next_page_token"
}
}Incidents Service
List incidents with filters
Lists all available incidents based on specified filters and order. The list is ordered in an unspecified direction and sorted by creation time.
Requires the following permissions:
incidents:read
List incidents with filters
curl --request POST \
--url https://api.coralogix.com/mgmt/openapi/4/incidents/incidents/v1 \
--header 'Authorization: <api-key>' \
--header 'Content-Type: application/json' \
--data '
{
"filter": {
"applicationName": [
"<string>"
],
"assignee": [
"<string>"
],
"contextualLabels": {},
"displayLabels": {},
"endTime": "2023-11-07T05:31:56Z",
"isMuted": true,
"metaLabels": [
{
"key": "key",
"value": "value"
}
],
"searchQuery": {
"query": "error"
},
"severity": [],
"startTime": "2023-11-07T05:31:56Z",
"state": [],
"status": [],
"subsystemName": [
"<string>"
]
},
"orderBys": [
{}
]
}
'import requests
url = "https://api.coralogix.com/mgmt/openapi/4/incidents/incidents/v1"
payload = {
"filter": {
"applicationName": ["<string>"],
"assignee": ["<string>"],
"contextualLabels": {},
"displayLabels": {},
"endTime": "2023-11-07T05:31:56Z",
"isMuted": True,
"metaLabels": [
{
"key": "key",
"value": "value"
}
],
"searchQuery": { "query": "error" },
"severity": [],
"startTime": "2023-11-07T05:31:56Z",
"state": [],
"status": [],
"subsystemName": ["<string>"]
},
"orderBys": [{}]
}
headers = {
"Authorization": "<api-key>",
"Content-Type": "application/json"
}
response = requests.post(url, json=payload, headers=headers)
print(response.text)const options = {
method: 'POST',
headers: {Authorization: '<api-key>', 'Content-Type': 'application/json'},
body: JSON.stringify({
filter: {
applicationName: ['<string>'],
assignee: ['<string>'],
contextualLabels: {},
displayLabels: {},
endTime: '2023-11-07T05:31:56Z',
isMuted: true,
metaLabels: [{key: 'key', value: 'value'}],
searchQuery: {query: 'error'},
severity: [],
startTime: '2023-11-07T05:31:56Z',
state: [],
status: [],
subsystemName: ['<string>']
},
orderBys: [{}]
})
};
fetch('https://api.coralogix.com/mgmt/openapi/4/incidents/incidents/v1', 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/4/incidents/incidents/v1",
CURLOPT_RETURNTRANSFER => true,
CURLOPT_ENCODING => "",
CURLOPT_MAXREDIRS => 10,
CURLOPT_TIMEOUT => 30,
CURLOPT_HTTP_VERSION => CURL_HTTP_VERSION_1_1,
CURLOPT_CUSTOMREQUEST => "POST",
CURLOPT_POSTFIELDS => json_encode([
'filter' => [
'applicationName' => [
'<string>'
],
'assignee' => [
'<string>'
],
'contextualLabels' => [
],
'displayLabels' => [
],
'endTime' => '2023-11-07T05:31:56Z',
'isMuted' => true,
'metaLabels' => [
[
'key' => 'key',
'value' => 'value'
]
],
'searchQuery' => [
'query' => 'error'
],
'severity' => [
],
'startTime' => '2023-11-07T05:31:56Z',
'state' => [
],
'status' => [
],
'subsystemName' => [
'<string>'
]
],
'orderBys' => [
[
]
]
]),
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/4/incidents/incidents/v1"
payload := strings.NewReader("{\n \"filter\": {\n \"applicationName\": [\n \"<string>\"\n ],\n \"assignee\": [\n \"<string>\"\n ],\n \"contextualLabels\": {},\n \"displayLabels\": {},\n \"endTime\": \"2023-11-07T05:31:56Z\",\n \"isMuted\": true,\n \"metaLabels\": [\n {\n \"key\": \"key\",\n \"value\": \"value\"\n }\n ],\n \"searchQuery\": {\n \"query\": \"error\"\n },\n \"severity\": [],\n \"startTime\": \"2023-11-07T05:31:56Z\",\n \"state\": [],\n \"status\": [],\n \"subsystemName\": [\n \"<string>\"\n ]\n },\n \"orderBys\": [\n {}\n ]\n}")
req, _ := http.NewRequest("POST", 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.post("https://api.coralogix.com/mgmt/openapi/4/incidents/incidents/v1")
.header("Authorization", "<api-key>")
.header("Content-Type", "application/json")
.body("{\n \"filter\": {\n \"applicationName\": [\n \"<string>\"\n ],\n \"assignee\": [\n \"<string>\"\n ],\n \"contextualLabels\": {},\n \"displayLabels\": {},\n \"endTime\": \"2023-11-07T05:31:56Z\",\n \"isMuted\": true,\n \"metaLabels\": [\n {\n \"key\": \"key\",\n \"value\": \"value\"\n }\n ],\n \"searchQuery\": {\n \"query\": \"error\"\n },\n \"severity\": [],\n \"startTime\": \"2023-11-07T05:31:56Z\",\n \"state\": [],\n \"status\": [],\n \"subsystemName\": [\n \"<string>\"\n ]\n },\n \"orderBys\": [\n {}\n ]\n}")
.asString();require 'uri'
require 'net/http'
url = URI("https://api.coralogix.com/mgmt/openapi/4/incidents/incidents/v1")
http = Net::HTTP.new(url.host, url.port)
http.use_ssl = true
request = Net::HTTP::Post.new(url)
request["Authorization"] = '<api-key>'
request["Content-Type"] = 'application/json'
request.body = "{\n \"filter\": {\n \"applicationName\": [\n \"<string>\"\n ],\n \"assignee\": [\n \"<string>\"\n ],\n \"contextualLabels\": {},\n \"displayLabels\": {},\n \"endTime\": \"2023-11-07T05:31:56Z\",\n \"isMuted\": true,\n \"metaLabels\": [\n {\n \"key\": \"key\",\n \"value\": \"value\"\n }\n ],\n \"searchQuery\": {\n \"query\": \"error\"\n },\n \"severity\": [],\n \"startTime\": \"2023-11-07T05:31:56Z\",\n \"state\": [],\n \"status\": [],\n \"subsystemName\": [\n \"<string>\"\n ]\n },\n \"orderBys\": [\n {}\n ]\n}"
response = http.request(request)
puts response.read_body{
"incidents": [
{
"assignments": [
{
"assignedBy": {
"userId": "user_id"
},
"assignedTo": {
"userId": "user_id"
}
}
],
"contextualLabels": {},
"createdAt": "2024-01-01T00:00:00.000Z",
"displayLabels": {},
"duration": "<string>",
"events": [
{
"id": "incident_event_id",
"administrativeEvent": {
"userId": "<string>"
},
"assignment": {
"assignment": {
"assignedBy": {
"userId": "user_id"
},
"assignedTo": {
"userId": "user_id"
}
}
}
}
],
"id": "incident_id",
"lastStateUpdateKey": "last_state_update_key",
"lastStateUpdateTime": "2024-01-01T00:00:00.000Z",
"closedAt": "2024-01-01T00:00:00.000Z",
"description": "incident_description",
"isMuted": false,
"metaLabels": [
{
"key": "key",
"value": "value"
}
],
"name": "incident_name"
}
],
"pagination": {
"totalSize": 100,
"nextPageToken": "next_page_token"
}
}Authorizations
API key authentication
Body
application/json
Request to list incidents with filtering, pagination and ordering options
Was this page helpful?
⌘I