Incidents

GraphQL schema reference · API guide · SDKs

Incidents affecting the tenant, with acknowledgement, assignment, notes, and resolution.

Types used by more than one domain are on Shared types.

Queries

Query.incident

One incident with its alerts and timeline. Null when the incident does not exist or is not visible to the caller.

incident(
  id: ID!
): IncidentDetail

Returns: IncidentDetail (IncidentDetail)

Arguments

• id: ID!

SDK

Operation	TypeScript	Go	Python
GetIncident	GetIncidentDocument	GetIncident	get_incident

Query.incidentsConnection

Incidents raised by platform alerting on clusters the current tenant owns, newest first.

incidentsConnection(
  page: ConnectionInput
  filter: IncidentFilterInput
): IncidentsConnection!

Returns: IncidentsConnection! (IncidentsConnection)

Arguments

• page: ConnectionInput (ConnectionInput) — Pagination options.
• filter: IncidentFilterInput (IncidentFilterInput) — Optional status and cluster filters.

SDK

Operation	TypeScript	Go	Python
GetIncidentsConnection	GetIncidentsConnectionDocument	GetIncidentsConnection	get_incidents_connection

Mutations

Mutation.addIncidentNote

Add a note to an incident’s timeline.

addIncidentNote(
  id: ID!
  body: String!
): IncidentMutationResult!

Returns: IncidentMutationResult! (IncidentMutationResult)

Arguments

• id: ID!
• body: String!

SDK

Operation	TypeScript	Go	Python
AddIncidentNote	AddIncidentNoteDocument	AddIncidentNote	add_incident_note

Mutation.assignIncident

Assign an incident to a user of the incident’s tenant. A null assignee clears the assignment.

assignIncident(
  id: ID!
  assigneeUserId: ID
): IncidentMutationResult!

Returns: IncidentMutationResult! (IncidentMutationResult)

Arguments

• id: ID!
• assigneeUserId: ID

SDK

Operation	TypeScript	Go	Python
AssignIncident	AssignIncidentDocument	AssignIncident	assign_incident

Mutation.resolveIncident

Resolve an incident manually. Repeats of the same firing alerts do not reopen it; a new alert opens a new incident.

resolveIncident(
  id: ID!
): IncidentMutationResult!

Returns: IncidentMutationResult! (IncidentMutationResult)

Arguments

• id: ID!

SDK

Operation	TypeScript	Go	Python
ResolveIncident	ResolveIncidentDocument	ResolveIncident	resolve_incident

Types

IncidentAlert

object

• fingerprint: String!
• status: String! — firing or resolved.
• labels: JSON! (JSON)
• annotations: JSON! (JSON)
• startsAt: Time! (Time)
• endsAt: Time (Time)
• generatorUrl: String

IncidentDetail

object

• incident: Incident! (Incident)
• alerts: [IncidentAlert!]! (IncidentAlert)
• timeline: [IncidentTimelineEvent!]! (IncidentTimelineEvent) — Oldest first.

IncidentEdge

object

• cursor: String!
• node: Incident! (Incident)

IncidentEventKind

enum

• ALERT_FIRING
• ALERT_RESOLVED
• ACKNOWLEDGED
• ASSIGNED
• NOTE
• RESOLVED
• INVESTIGATION_ATTACHED
• NOTIFIED
• SCOPE_CHANGED — The incident’s visibility moved after its cluster owner was confirmed.

IncidentFilterInput

input_object

• statuses: [IncidentStatus!] (IncidentStatus) — Empty or omitted matches every status.
• clusterId: String

IncidentTimelineEvent

object

• id: ID!
• kind: IncidentEventKind! (IncidentEventKind)
• actorUserId: ID — Null for events produced by alerting or services.
• createdAt: Time! (Time)
• note: String — NOTE events.
• assignedTo: ID — ASSIGNED events; null clears the assignment.
• reportId: ID — INVESTIGATION_ATTACHED events: the Skipper report.
• channel: String — NOTIFIED events: email, slack, or discord.
• resolution: IncidentResolution (IncidentResolution) — RESOLVED events.
• alertFingerprint: String — ALERT_FIRING and ALERT_RESOLVED events.
• alertname: String — ALERT_FIRING and ALERT_RESOLVED events.

IncidentsConnection

object

• edges: [IncidentEdge!]! (IncidentEdge)
• nodes: [Incident!]! (Incident)
• pageInfo: PageInfo! (PageInfo)
• totalCount: Int!