List Compute instances
/unified/cloud-infrastructure/compute_instances
Query Parameters
Refer Specifying query parameters in Truto APIs
AWS region to read. EC2 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 Compute instances
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
Security groups on the machine and on every one of its network interfaces.
1 supported
1 property
The target's id.
The zone the machine runs in.
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
Whether any network interface has a public IPv4 address.
1 supported
The image the machine was launched from. machine_images lists only images the account owns, so an Amazon, Marketplace or other shared image does not resolve there; GET machine_images/{id} still reads it.
1 supported
1 property
The target's id.
The image the machine was launched from, verbatim (an AMI id on AWS).
1 supported
The provider's own identifier for the machine, verbatim (an EC2 i- id, an Azure VM resource id, a GCP instance id).
1 supported
The provider's size or machine type, verbatim (t3.micro, Standard_D2s_v3, e2-medium).
1 supported
IPv6 addresses on any network interface. These are globally unique; whether they are reachable from the internet depends on routing and firewall rules.
1 supported
Whether a fleet-management service (AWS Systems Manager, Azure Arc or Update Manager, GCP VM Manager) currently registers the machine as a managed node. On AWS, Systems Manager does not report stopped instances, so a stopped instance reads false even when it is registered. Read on GET only.
1 supported
When the machine last started. On AWS this moves on every stop and start, so it is not a creation date.
1 supported
The identity the machine runs as, verbatim: on AWS the instance profile ARN (an instance profile holds one IAM role; it is not the role ARN workload_identities is keyed on), on Azure the managed identity, on GCP the service account. Null when the machine has none.
1 supported
The managed-node record for this machine, when is_managed is true. Read on GET only.
1 supported
1 property
The target's id.
The instance metadata service (IMDS) settings. Null when the provider did not return them - see unreadable_fields.
1 supported
3 properties
Whether the metadata endpoint answers at all.
How many network hops a metadata response may travel. Above 1, containers on the host can reach the endpoint.
Whether every metadata request must carry a session token. On AWS true is IMDSv2-only (httpTokens required); false still answers IMDSv1 requests without a token.
The display name: on AWS the Name tag, which is optional, so null means the instance has no Name tag.
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
The VPC / virtual network the machine sits in.
1 supported
1 property
The target's id.
Operating system family. linux_unix covers Linux and other Unix-like systems; unknown when the provider does not say. The provider's own value is in remote_data.
windowslinux_unixmacosunknown
1 supported
Every private IPv4 address on any of the machine's network interfaces.
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
Every public IPv4 address on any network interface, including addresses on secondary private IPs. Empty means no public IPv4.
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
Lifecycle state, normalised. On AWS shutting-down is 'terminating'. Terminated EC2 instances stay listed for about an hour. The provider's own value is in remote_data.
pendingrunningstoppingstoppedterminatingterminatedunknown
1 supported
The subnet of the primary network interface, verbatim.
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
truto unified cloud-infrastructure computeinstances \
-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',
'computeinstances',
{ 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",
"computeinstances",
{"integrated_account_id": "<integrated_account_id>"}
):
print(item)
asyncio.run(main())curl -X GET 'https://api.truto.one/unified/cloud-infrastructure/compute_instances?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/compute_instances?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/compute_instances"
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())