Skip to content
GET /unified/cloud-infrastructure/network_links

Query Parameters

Refer Specifying query parameters in Truto APIs

link_typestring

Which link primitive to read: 'vpc_peering' (default), 'transit_gateway' or 'transit_gateway_attachment'. Call each for full coverage.

Possible values:
interconnectotherpeeringshared_networktransit_attachmenttransit_gatewaytransit_gateway_attachmentvpc_peeringvpn
1 supported
Amazon Web Services
supported
vpc_peeringtransit_gatewaytransit_gateway_attachment
regionstring

AWS region to read. These link primitives are regional; one call reads one region.

1 supported
Amazon Web Services
supported
Show Truto-specific parameters
integrated_account_idstring · uuid
required·

The ID of the integrated account to use for the request.

Example: 62f44730-dd91-461e-bd6a-aedd9e0ad79d
truto_response_formatstring

The format of the response.

  • unified returns the response with unified mappings applied.
  • raw returns the unprocessed, raw response from the remote API.
  • normalized applies the unified mappings and returns the data in a normalized format.
  • stream returns 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.
  • debug returns the final unified result alongside raw remote fetch information. The response is an envelope containing result (identical to unified mode output) and debug (with requestUrl, requestOptions, data, responseHeaders, and for list operations: nextCursor, isLooping, isEmptyResult, resultCount). When the upstream body exceeds 1 MiB, data is replaced by { truto_truncated: true, truto_max_bytes, truto_excerpt }. debug is null for static responses or when truto_skip_api_call=true.

Defaults to unified.

Example: unified
Possible values:
unifiedrawnormalizedstreamdebug
truto_key_bystring

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.

Example: id
truto_ignore_limitboolean

Ignores the limit query parameter.

truto_ignore_remote_databoolean

Excludes the remote_data attribute from the response.

truto_exclude_fieldsstring[]

Array of fields to exclude from the response.

Example: truto_exclude_fields[]=id&truto_exclude_fields[]=name
remote_queryRecord<string, any>

Query parameters to pass to the underlying API without any transformations. Refer this guide to see how to structure the query parameters.

Example: remote_query[foo]=bar

Response Body

debugobject

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.

data
isEmptyResultboolean
isLoopingboolean
nextCursorstring
requestOptionsRecord<string, any>
requestUrlstring
responseHeadersRecord<string, any>
resultCountnumber
next_cursorstring

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.

resultobject[]

List of Network links

idstring
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.

1 supported
Amazon Web Services
supported
accountstring

The account, subscription or project this object belongs to.

References: Accounts → id
1 supported
Amazon Web Services
supported
allows_transitboolean

Whether traffic can transit to a third network through this link. Always false for AWS VPC peering. For transit gateways, it's derived from associations and propagations combined, not one attachment field.

1 supported
Amazon Web Services
supported
collected_atstring · date-time

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
Amazon Web Services
supported
created_atstring

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
Amazon Web Services
supported
default_route_table_associationboolean

For transit gateways, whether attachments associate with the default route table automatically. With default_route_table_propagation both true, every attached network can reach every other.

1 supported
Amazon Web Services
supported
default_route_table_propagationboolean

For transit gateways, whether attachment routes propagate into the default route table automatically.

1 supported
Amazon Web Services
supported
link_idstring

The provider's own identifier for the link.

1 supported
Amazon Web Services
supported
link_typestring

What kind of connection this is.

Possible values:
peeringtransit_attachmentshared_networkvpninterconnectother
1 supported
Amazon Web Services
supported
local_boundaryobject

The network on this side of the link.

1 supported
Amazon Web Services
supported
1 property
idstring

The target's id.

native_typestring

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
Amazon Web Services
supported
providerstring

Which cloud this object was read from.

Possible values:
awsazuregcp
1 supported
Amazon Web Services
supported
provider_idstring

The provider's own identifier, passed through verbatim — a full ARN, resource id, or self-link. Never truncated, prefixed, or normalized.

1 supported
Amazon Web Services
supported
regionstring

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
Amazon Web Services
supported
remote_account_idstring

The account owning the far side of the link. Local/remote are assigned by account ownership, not by which side initiated the connection.

1 supported
Amazon Web Services
supported
remote_boundaryobject

The network on the far side of the link. Resolves only when the far side is an account this connection also reads.

1 supported
Amazon Web Services
supported
1 property
idstring

The target's id.

remote_dataRecord<string, any>

Raw data returned from the remote API call.

remote_regionstring

The region on the far side of the link.

1 supported
Amazon Web Services
supported
route_exchange_settingsobject

Route exchange configuration, where the provider has one. AWS VPC peering has no real equivalent (only a DNS-resolution option survives); null with not_supported_by_provider there.

1 supported
Amazon Web Services
supported
1 property
allow_dns_resolution_from_remote_vpcboolean

AWS allowDnsResolutionFromRemoteVpc. Whether the remote network can resolve private DNS on this side. This is DNS, not routing - AWS VPC peering exchanges no routes automatically.

routes_installedboolean

Whether routes actually exist for this link. An active peering state doesn't mean routes were added — that's a separate, manual step on AWS.

1 supported
Amazon Web Services
supported
statestring

The provider's own state string for the link, verbatim.

1 supported
Amazon Web Services
supported
tagsobject

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
Amazon Web Services
supported
unreadable_fieldsobject[]

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
Amazon Web Services
supported
3 properties
detailstring

Explanation of the reason, where one adds anything.

fieldstring

The property on this resource that could not be read.

reasonstring

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.

Possible values:
not_supported_by_providernot_configuredpermission_deniednot_collectedcollection_errorpartially_collectedavailable_on_get
updated_atstring

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
Amazon Web Services
supported
truto unified cloud-infrastructure networklinks \
  -a '<integrated_account_id>' \
  -o json
import Truto from '@truto/truto-ts-sdk';

const truto = new Truto({
  token: '<your_api_token>',
});

const result = await truto.unifiedApi.list(
  'cloud-infrastructure',
  'networklinks',
  { 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",
        "networklinks",
        {"integrated_account_id": "<integrated_account_id>"}
    ):
        print(item)

asyncio.run(main())
curl -X GET 'https://api.truto.one/unified/cloud-infrastructure/network_links?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/network_links?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/network_links"
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())