Docs

Type a word or a question. Esc closes the search.

Sign in Start free

List incidents

Returns incident counts and items for the selected client scope, with optional q, sort and cursor parameters.

GET https://app.upfour.io/v1/incidents
GET https://app.upfour.io/v1/incidents
Authorization
AuthorizationA pls_ key. It stays in this browser tab. Needs incident.read.
Query

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 incident.read stable returns 200

Parameters

FieldTypeDescription
limit optional integer 1–250default 50 query parameter
cursor optional string query parameter
client_id optional uuid query parameter
all_clients optional boolean query parameter
q optional string query parameter
sort optional string query parameter

Returns

A successful request returns 200 with application/json.

Response fields 1 top-level fields
FieldTypeDescription
data IncidentListResult
IncidentListResult · 49 fields
FieldTypeDescription
counts IncidentCounts
IncidentCounts · 7 fields
FieldTypeDescription
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
FieldTypeDescription
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 ofeveryoneescalation_policyteam
severity string one ofcriticalwarninginfo
started_at string (date-time)
started_by_type string
started_by_user_id uuid · nullable
status string one ofopenacknowledgedresolved
title string
updated_at string (date-time)
user_id uuid
escalation_target_channel_count integer
escalation_target_kind string one ofnobodychannel_countchannel_count_with_policyname
escalation_target_name string
notified_channel_count integer
notified_kind string one ofnobodydelivery_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.

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