List Monitoring alarms
/unified/cloud-infrastructure/monitoring_alarms
Query Parameters
Refer Specifying query parameters in Truto APIs
AWS region to read. CloudWatch is regional; one call reads one region.
1 supported
Which alarms to read: 'metric' (default) or 'composite'. AWS returns them from separate calls; call both for full coverage.
compositemetric
1 supported
Opt-in reads. Naming notifies_confirmed_subscriber or actions also reads each distinct SNS topic of the page once (sns:GetTopicAttributes, at most 25 per page) to fill has_confirmed_subscriber. Accepts fields[]=a&fields[]=b or a comma-separated string.
1 supported
Show Truto-specific parameters
The ID of the integrated account to use for the request.
62f44730-dd91-461e-bd6a-aedd9e0ad79dThe format of the response.
unifiedreturns the response with unified mappings applied.rawreturns the unprocessed, raw response from the remote API.normalizedapplies the unified mappings and returns the data in a normalized format.streamreturns the response as a stream, which is ideal for transmitting large datasets, files, or binary data. Using streaming mode helps to efficiently handle large payloads or real-time data flows without requiring the entire data to be buffered in memory.debugreturns the final unified result alongside raw remote fetch information. The response is an envelope containingresult(identical to unified mode output) anddebug(withrequestUrl,requestOptions,data,responseHeaders, and for list operations:nextCursor,isLooping,isEmptyResult,resultCount). When the upstream body exceeds 1 MiB,datais replaced by{ truto_truncated: true, truto_max_bytes, truto_excerpt }.debugisnullfor static responses or whentruto_skip_api_call=true.
Defaults to unified.
unifiedunifiedrawnormalizedstreamdebug
By default the result attribute is an array of objects. This parameter allows you to specify a field in each result objects to use as key, which transforms the result array into an object with the array items keyed by the field. This is useful for when you want to use the result as a lookup table.
idIgnores the limit query parameter.
Excludes the remote_data attribute from the response.
Array of fields to exclude from the response.
truto_exclude_fields[]=id&truto_exclude_fields[]=nameQuery parameters to pass to the underlying API without any transformations. Refer this guide to see how to structure the query parameters.
remote_query[foo]=barResponse Body
Present only when truto_response_format=debug. Contains raw fetch details: requestUrl, requestOptions, data, responseHeaders, nextCursor, isLooping, isEmptyResult, resultCount. data is the parsed upstream body; when its JSON form exceeds 1 MiB it is replaced by { truto_truncated: true, truto_max_bytes, truto_excerpt }, where truto_excerpt is the leading bytes of that body. The same applies to a string requestOptions.body. null for static responses or when truto_skip_api_call=true.
The cursor to use for the next page of results. Pass this value as next_cursor in the query parameter in the next request to get the next page of results.
List of Monitoring alarms
Truto's stable unified identifier for this object. Opaque; use provider_id to address the object in the provider's own console or API.
1 supported
The account, subscription or project this object belongs to.
1 supported
What the alarm does on each state change.
1 supported
5 properties
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.
The topic, when target_type is notification_topic.
1 property
The target's id.
The state change that triggers this action. The provider's own value is in remote_data.
alarmokinsufficient_data
The action target, verbatim (an ARN on AWS).
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.
notification_topicscaling_policyinstance_actionincident_managementfunctionother
Whether the alarm runs its actions. False means it changes state silently.
1 supported
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.
metriccomposite
1 supported
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.
1 supported
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.
greater_than_or_equalgreater_thanless_thanless_than_or_equaloutside_bandbelow_bandabove_bandunknown
1 supported
When the object was created at the provider, in UTC ISO 8601. Null when the provider does not record one - see unreadable_fields.
1 supported
How many breaching periods within evaluation_periods make the alarm fire.
1 supported
The alarm's description, verbatim.
1 supported
How many periods are evaluated.
1 supported
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.
1 supported
8 properties
Dimension name to value, exactly as set.
A metric-math expression. Null for a plain metric.
The entry's id inside a metric-math alarm. Null for a single-metric alarm.
Metric name, verbatim.
Metric namespace, verbatim (AWS/EC2, or a log metric filter's namespace).
Aggregation period in seconds.
Whether this entry is the value the alarm evaluates.
Statistic or percentile, verbatim (Average, Sum, p99 ...).
The alarm's name, verbatim.
1 supported
The provider's own type string, unmodified — for example 'AWS::S3::Bucket', 'aws_iam_role', 'Microsoft.Sql/servers'. Used for display and drill-down.
1 supported
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.
1 supported
Evaluation period of a single-metric alarm.
1 supported
Which cloud this object was read from.
awsazuregcp
1 supported
The provider's own identifier, passed through verbatim — a full ARN, resource id, or self-link. Never truncated, prefixed, or normalized.
1 supported
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.
1 supported
Raw data returned from the remote API call.
1 supported
A composite alarm's rule expression, verbatim. Null for a metric alarm.
1 supported
Current alarm state. The provider's own value is in remote_data.
okalarminsufficient_dataunknown
1 supported
Why the alarm is in its state, as the provider words it.
1 supported
When the state last changed.
1 supported
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.
1 supported
The threshold. Null for a composite alarm, or a band alarm that compares against another metric.
1 supported
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.
missingnot_breachingbreachingignoreunknown
1 supported
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.
1 supported
3 properties
Explanation of the reason, where one adds anything.
The property on this resource that could not be read.
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.
not_supported_by_providernot_configuredpermission_deniednot_collectedcollection_errorpartially_collectedavailable_on_get
When the object was last modified at the provider, in UTC ISO 8601. Null when the provider does not record one - see unreadable_fields.
1 supported
truto unified cloud-infrastructure monitoringalarms \
-a '<integrated_account_id>' \
-o jsonimport Truto from '@truto/truto-ts-sdk';
const truto = new Truto({
token: '<your_api_token>',
});
const result = await truto.unifiedApi.list(
'cloud-infrastructure',
'monitoringalarms',
{ integrated_account_id: '<integrated_account_id>' }
);
console.log(result);import asyncio
from truto_python_sdk import TrutoApi
truto_api = TrutoApi(token="<your_api_token>")
async def main():
async for item in truto_api.unified_api.list(
"cloud-infrastructure",
"monitoringalarms",
{"integrated_account_id": "<integrated_account_id>"}
):
print(item)
asyncio.run(main())curl -X GET 'https://api.truto.one/unified/cloud-infrastructure/monitoring_alarms?integrated_account_id=<integrated_account_id>' \
-H 'Authorization: Bearer <your_api_token>' \
-H 'Content-Type: application/json'const integratedAccountId = '<integrated_account_id>';
const response = await fetch(`https://api.truto.one/unified/cloud-infrastructure/monitoring_alarms?integrated_account_id=${integratedAccountId}`, {
method: 'GET',
headers: {
'Authorization': 'Bearer <your_api_token>',
'Content-Type': 'application/json',
},
});
const data = await response.json();
console.log(data);import requests
url = "https://api.truto.one/unified/cloud-infrastructure/monitoring_alarms"
headers = {
"Authorization": "Bearer <your_api_token>",
"Content-Type": "application/json",
}
params = {
"integrated_account_id": "<integrated_account_id>"
}
response = requests.get(url, headers=headers, params=params)
print(response.json())