Skip to main content

createInstanceAlarm

form schema

Register a cloud metric alarm with an instance.

The alarm appears in the UI immediately and starts receiving state updates as soon as the cloud provider reports them. The cloudResourceId is used to correlate inbound webhooks (CloudWatch, Azure Monitor, GCP Cloud Monitoring, Alertmanager) back to this alarm — it must be unique within the instance.

Requires environment:update on the alarm's environment.

createInstanceAlarm(
organizationId: ID!
instanceId: ID!
input: CreateInstanceAlarmInput!
): AlarmPayload

Form Schema

This mutation supports dynamic form generation using JSON Schema.

Loading schema...

Arguments

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

Your organization's unique identifier.

createInstanceAlarm.instanceId ● ID! non-null scalar {#instance-id}

The instance to attach the alarm to.

createInstanceAlarm.input ● CreateInstanceAlarmInput! non-null input {#input}

Register a cloud metric alarm with an instance. The alarm appears in the UI immediately and receives state transitions as soon as the cloud provider reports them. Webhooks from AWS CloudWatch, Azure Monitor, GCP Cloud Monitoring, and Prometheus Alertmanager match against cloudResourceId to attach state.

Type

AlarmPayload object