List incidents

Lists incidents for a monitor.

GET https://app.upfour.io/v1/monitors/{monitorID}/incidents

Authorization

AuthorizationA pls_ key. It stays in this browser tab. Needs monitor.read.

Path

monitorIDpath · requiredPart of the request path.

Sent directly from your browser to https://app.upfour.io/v1. Mutating calls get an automatic Idempotency-Key when the field is empty.

Request

Responsenot sent yet

Fill in a key and press Send request (⌘↵).
The answer appears here.

scope monitor.read stable returns 200

Parameters

Field	Type	Description
`monitorID` required	uuid	path parameter

Returns

A successful request returns 200 with application/json.

Response fields 1 top-level fields

Field Type Description

data IncidentListResult

IncidentListResult · 49 fields

Field Type Description

counts IncidentCounts

IncidentCounts · 7 fields

Field	Type	Description
`acknowledged`	integer
`open`	integer
`resolved_in_window`	integer
`started_in_window`	integer
`unresolved`	integer
`window_from`	string (date-time)
`window_to`	string (date-time)

items Incident[] · nullable

Each item · 37 fields

Field	Type	Description
`acknowledged_at`	string (date-time) · nullable
`cause`	string
`check_method`	string
`check_url`	string
`client_id`	uuid · nullable
`correlated_count`	integer
`created_at`	string (date-time)
`created_by`	string
`description`	string
`duration_seconds`	integer · nullable
`escalation_target_label`	string
`heartbeat_id`	uuid · nullable
`heartbeat_name`	string
`id`	uuid
`metadata`	map of string · nullable max 100 keyseach value max length 4096	Custom key/value pairs (at most 100 keys; keys 1-128 characters, values up to 4096). Sent to machine-readable alert channels and API webhook subscriptions, and copied onto the incidents the resource opens.
`monitor_id`	uuid · nullable
`monitor_name`	string
`notified_label`	string
`override_channel_ids`	uuid[] · nullable
`resolved_at`	string (date-time) · nullable
`resolved_by_type`	string · nullable
`resolved_by_user_id`	uuid · nullable
`routing_target_id`	uuid · nullable
`routing_type`	string one of`everyoneescalation_policyteam`
`severity`	string one of`criticalwarninginfo`
`started_at`	string (date-time)
`started_by_type`	string
`started_by_user_id`	uuid · nullable
`status`	string one of`openacknowledgedresolved`
`title`	string
`updated_at`	string (date-time)
`user_id`	uuid
`escalation_target_channel_count`	integer
`escalation_target_kind`	string one of`nobodychannel_countchannel_count_with_policyname`
`escalation_target_name`	string
`notified_channel_count`	integer
`notified_kind`	string one of`nobodydelivery_failedchannel_countchannel`

page integer

per_page integer

total integer

Errors

Only the errors this operation can return. Every error uses the same envelope.

Status	Code	Meaning
400	`bad_request`	The request is malformed or fails validation.
404	`not_found`	The requested resource does not exist or is outside the caller's scope.

Every call can also return unauthorized (401), rate_limit_exceeded (429) or internal_error (500 / 502). See Responses and errors.

const res = await fetch("https://app.upfour.io/v1/monitors/00000000-0000-4000-8000-000000000001/incidents", { headers: { Authorization: `Bearer ${process.env.UP4_API_KEY}`, }, }); console.log(res.status, await res.json());

import os import requests res = requests.get( "https://app.upfour.io/v1/monitors/00000000-0000-4000-8000-000000000001/incidents", headers={"Authorization": f"Bearer {os.environ['UP4_API_KEY']}"}, ) print(res.status_code, res.json())

package main import ( "fmt" "io" "net/http" "os" ) func main() { req, _ := http.NewRequest("GET", "https://app.upfour.io/v1/monitors/00000000-0000-4000-8000-000000000001/incidents", nil) req.Header.Set("Authorization", "Bearer "+os.Getenv("UP4_API_KEY")) res, err := http.DefaultClient.Do(req) if err != nil { panic(err) } defer res.Body.Close() out, _ := io.ReadAll(res.Body) fmt.Println(res.StatusCode, string(out)) }

<?php $ch = curl_init("https://app.upfour.io/v1/monitors/00000000-0000-4000-8000-000000000001/incidents"); curl_setopt_array($ch, [ CURLOPT_RETURNTRANSFER => true, CURLOPT_HTTPHEADER => [ "Authorization: Bearer " . getenv("UP4_API_KEY"), ], ]); $response = curl_exec($ch); echo curl_getinfo($ch, CURLINFO_RESPONSE_CODE), " ", $response, "\n"; curl_close($ch);

{ "data": { "counts": { "acknowledged": 0, "open": 0, "resolved_in_window": 0, "started_in_window": 0, "unresolved": 0 }, "items": [], "page": 1, "per_page": 25, "total": 0 } }