# MonitoringAlarms Object

> Source: https://truto.one/docs/api-reference/unified-cloud-infrastructure-api/monitoringalarms/

Schema for the `MonitoringAlarms` resource in **Unified Cloud Infrastructure API**.

## Properties

- **`id`** _(string, required)_
  Truto's stable unified identifier for this object. Opaque; use provider_id to address the object in the provider's own console or API.
- **`provider_id`** _(string)_
  The provider's own identifier, passed through verbatim — a full ARN, resource id, or self-link. Never truncated, prefixed, or normalized.
- **`provider`** _(string)_
  Which cloud this object was read from.
  Allowed: `aws`, `azure`, `gcp`
- **`account`** _(string)_
  The account, subscription or project this object belongs to.
- **`region`** _(string)_
  Where the object is located. 'global' denotes genuinely global resources (e.g. IAM, GCP VPC networks) rather than a guessed region. A substituted region (when none is derivable) is flagged in unreadable_fields.
- **`native_type`** _(string)_
  The provider's own type string, unmodified — for example 'AWS::S3::Bucket', 'aws_iam_role', 'Microsoft.Sql/servers'. Used for display and drill-down.
- **`tags`** _(object)_
  Key-value pairs exactly as the customer set them: no case folding, key/value normalization, or merging of separate provider concepts. An empty object means no tags; tags that could not be read appear in unreadable_fields instead.
- **`collected_at`** _(string)_
  When Truto actually read this object from the provider, in UTC ISO 8601 with the offset present — not the request time, and not a provider timestamp.
- **`updated_at`** _(string)_
  When the object was last modified at the provider, in UTC ISO 8601. Null when the provider does not record one - see unreadable_fields.
- **`created_at`** _(string)_
  When the object was created at the provider, in UTC ISO 8601. Null when the provider does not record one - see unreadable_fields.
- **`unreadable_fields`** _(array<object>)_
  Fields on this object that could not be read, and why. An empty array means everything was read. Use this to tell a real value from a missing one.
  - **`field`** _(string)_
    The property on this resource that could not be read.
  - **`reason`** _(string)_
    Why the field could not be read. available_on_get: Not read on list to keep the list fast; call GET for this resource's id to get it.
    Allowed: `not_supported_by_provider`, `not_configured`, `permission_denied`, `not_collected`, `collection_error`, `partially_collected`, `available_on_get`
  - **`detail`** _(string)_
    Explanation of the reason, where one adds anything.
- **`remote_data`** _(object)_
  Raw data returned from the remote API call.
- **`name`** _(string)_
  The alarm's name, verbatim.
- **`alarm_type`** _(string)_
  metric: watches one metric or a metric expression. composite: combines other alarms through a rule. The list reads one type per call (alarm_type query parameter). The provider's own value is in remote_data.
  Allowed: `metric`, `composite`
- **`description`** _(string)_
  The alarm's description, verbatim.
- **`state`** _(string)_
  Current alarm state. The provider's own value is in remote_data.
  Allowed: `ok`, `alarm`, `insufficient_data`, `unknown`
- **`state_reason`** _(string)_
  Why the alarm is in its state, as the provider words it.
- **`state_updated_at`** _(string)_
  When the state last changed.
- **`actions_enabled`** _(boolean)_
  Whether the alarm runs its actions. False means it changes state silently.
- **`metrics`** _(array<object>)_
  What a metric alarm watches: one entry for a single-metric alarm, or every metric and expression of a metric-math alarm. Empty for a composite alarm.
  - **`id`** _(string)_
    The entry's id inside a metric-math alarm. Null for a single-metric alarm.
  - **`expression`** _(string)_
    A metric-math expression. Null for a plain metric.
  - **`namespace`** _(string)_
    Metric namespace, verbatim (AWS/EC2, or a log metric filter's namespace).
  - **`name`** _(string)_
    Metric name, verbatim.
  - **`dimensions`** _(object)_
    Dimension name to value, exactly as set.
  - **`statistic`** _(string)_
    Statistic or percentile, verbatim (Average, Sum, p99 ...).
  - **`period_seconds`** _(integer)_
    Aggregation period in seconds.
  - **`returns_data`** _(boolean)_
    Whether this entry is the value the alarm evaluates.
- **`comparison_operator`** _(string)_
  How the value is compared, normalised. outside_band, below_band and above_band compare against an anomaly-detection band instead of a threshold. Null for a composite alarm. The provider's own value is in remote_data.
  Allowed: `greater_than_or_equal`, `greater_than`, `less_than`, `less_than_or_equal`, `outside_band`, `below_band`, `above_band`, `unknown`
- **`threshold`** _(number)_
  The threshold. Null for a composite alarm, or a band alarm that compares against another metric.
- **`evaluation_periods`** _(integer)_
  How many periods are evaluated.
- **`datapoints_to_alarm`** _(integer)_
  How many breaching periods within evaluation_periods make the alarm fire.
- **`period_seconds`** _(integer)_
  Evaluation period of a single-metric alarm.
- **`treat_missing_data`** _(string)_
  What missing data points count as. missing: the alarm looks further back for enough points; ignore: the current state is kept. Null for a composite alarm. The provider's own value is in remote_data.
  Allowed: `missing`, `not_breaching`, `breaching`, `ignore`, `unknown`
- **`rule`** _(string)_
  A composite alarm's rule expression, verbatim. Null for a metric alarm.
- **`actions`** _(array<object>)_
  What the alarm does on each state change.
  - **`on_state`** _(string)_
    The state change that triggers this action. The provider's own value is in remote_data.
    Allowed: `alarm`, `ok`, `insufficient_data`
  - **`target_id`** _(string)_
    The action target, verbatim (an ARN on AWS).
  - **`target_type`** _(string)_
    What kind of target it is. notification_topic: a pub/sub topic (SNS); scaling_policy: an autoscaling policy; instance_action: stop, terminate, reboot or recover a machine; incident_management: an OpsItem or incident; function: a serverless function. The provider's own value is in remote_data.
    Allowed: `notification_topic`, `scaling_policy`, `instance_action`, `incident_management`, `function`, `other`
  - **`notification_topic`** _(object)_
    The topic, when target_type is notification_topic.
    - **`id`** _(string)_
      The target's `id`.
  - **`has_confirmed_subscriber`** _(boolean)_
    For a notification topic: whether it has at least one confirmed subscription. Null for other targets, and for a topic that was not read: one in another account, or a read that failed (for an ALARM-state topic the notifies_confirmed_subscriber entry in unreadable_fields says which). Read on GET, or on the list with fields[]=notifies_confirmed_subscriber.
- **`notifies_confirmed_subscriber`** _(boolean)_
  Whether the alarm, when it fires, reaches at least one person or system: actions are enabled and at least one ALARM-state action is a notification topic with a confirmed subscription. False when actions are disabled or no ALARM-state action is a topic. Null when a topic could not be read. Read on GET, or on the list with fields[]=notifies_confirmed_subscriber.

## Methods

- [GET /unified/cloud-infrastructure/monitoring_alarms/{id}](/docs/api-reference/unified-cloud-infrastructure-api/monitoringalarms/get) — Get Monitoring alarms
- [GET /unified/cloud-infrastructure/monitoring_alarms](/docs/api-reference/unified-cloud-infrastructure-api/monitoringalarms/list) — List Monitoring alarms