List Instance groups
/unified/cloud-infrastructure/instance_groups
Query Parameters
Refer Specifying query parameters in Truto APIs
AWS region to read. Auto Scaling is regional; one call reads one region.
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 Instance groups
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
Zones the group may launch into.
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
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 machines the group is trying to run right now.
1 supported
How long a new machine is spared from health checks.
1 supported
Health checks that decide when a machine is replaced, normalised. instance: the provider's machine status checks (on AWS EC2); load_balancer: load balancer target health (ELB); service_network: service network target health (VPC Lattice); block_volume: attached volume health (EBS). instance alone means a machine failing a load balancer check is not replaced. The provider's own value is in remote_data.
1 supported
instanceload_balancerservice_networkblock_volumeunknown
Machines currently in the group.
1 supported
7 properties
Zone the machine runs in.
The group's health verdict for the machine. The provider's own value is in remote_data.
healthyunhealthyunknown
The machine's own id, verbatim.
Machine type, verbatim.
Where the machine is in the group lifecycle, normalised. pending and terminating include their lifecycle-hook wait steps; warm_pool: a pre-initialised machine in the warm pool; standby: taken out of service but kept in the group. The provider's own value is in remote_data.
pendingin_servicestandbydetachingdetachedterminatingterminatedwarm_poolunknown
Whether scale-in may not remove this machine.
The launch template the group launches from (on AWS an lt- id, also when it comes from a mixed instances policy). Null when the group uses a legacy launch configuration.
1 supported
The template version the group uses, verbatim ($Latest, $Default or a number on AWS).
1 supported
Load balancer target groups (ARNs) and classic load balancer names the group registers its machines with.
1 supported
Most machines the group may run.
1 supported
Fewest machines the group keeps.
1 supported
The group'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
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.
The identity the scaling service acts as (on AWS the service-linked role).
1 supported
1 property
The target's id.
deleting while the group is being deleted; null otherwise. The provider's own value is in remote_data.
deletingunknown
1 supported
Subnets the group launches into.
1 supported
Scaling processes that are suspended, verbatim (Launch, Terminate, HealthCheck, ReplaceUnhealthy ... on AWS). A suspended HealthCheck or ReplaceUnhealthy stops unhealthy machines being replaced.
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
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
Whether the group launches from a legacy launch definition the provider no longer extends (an AWS launch configuration). False on providers without one.
1 supported
truto unified cloud-infrastructure instancegroups \
-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',
'instancegroups',
{ 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",
"instancegroups",
{"integrated_account_id": "<integrated_account_id>"}
):
print(item)
asyncio.run(main())curl -X GET 'https://api.truto.one/unified/cloud-infrastructure/instance_groups?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/instance_groups?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/instance_groups"
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())