Skip to main content

instanceAlarm

Fetch a single alarm by its unique identifier.

Returns the alarm with its most recent currentState attached, or a NOT_FOUND error if the alarm doesn't exist or its project isn't visible to the caller.

query {
  instanceAlarm(organizationId: "my-org", id: "0192…uuid") {
    id
    displayName
    currentState { status occurredAt }
    metric { namespace name }
  }
}
instanceAlarm(
  organizationId: ID!
  id: UUID!
): Alarm

Arguments​

instanceAlarm.organizationId ● ID! non-null scalar {#organization-id}​

Your organization's unique identifier.

instanceAlarm.id ● UUID! non-null scalar {#id}​

The alarm's unique identifier.

Type​

Alarm object​

A cloud metric alarm attached to an instance.

Receives state updates via webhooks from AWS CloudWatch, Azure Monitor, GCP Cloud Monitoring, or Prometheus Alertmanager.

Check currentState to see whether the alarm is firing. A null currentState means no state has been reported yet for this alarm.