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

Query Parameters

Refer Specifying query parameters in Truto APIs

scope_typestring

Which firewall primitive to read: 'security_group' (default) or 'network_acl'. They are separate primitives read separately; call both for full coverage.

Possible values:
firewall_policyfirewall_rulenetwork_aclsecurity_groupunknown
1 supported
Amazon Web Services
supported
security_groupnetwork_acl
regionstring

AWS region to read. Security groups and network ACLs 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 Firewall rule sets

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
attached_boundaryobject

The network boundary this rule set belongs to.

1 supported
Amazon Web Services
supported
1 property
idstring

The target's id.

attached_tostring[]

What this rule set is attached to, as provider references. Null for security groups, where attachment is not in the provider model.

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
descriptions_supportedboolean

Whether this primitive has a per-rule description field at all — distinct from a rule having no description. AWS security group rules have one; network ACL entries do not.

1 supported
Amazon Web Services
supported
has_open_ingress_from_anywhereboolean

Whether any rule permits inbound traffic from the whole internet. Derived.

1 supported
Amazon Web Services
supported
is_orderedboolean

Whether rule order determines evaluation. False for AWS security groups, an unordered set evaluated as a union — array position is not a priority.

1 supported
Amazon Web Services
supported
is_statefulboolean

Whether return traffic is implicitly allowed.

1 supported
Amazon Web Services
supported
namestring

The rule set name.

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

True when attached_to was observed from live interfaces rather than read from configuration — a point-in-time observation, not a stable config fact.

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_dataRecord<string, any>

Raw data returned from the remote API call.

rule_countinteger

How many rules this set contains.

1 supported
Amazon Web Services
supported
rule_set_idstring

The provider's own identifier for the rule set.

1 supported
Amazon Web Services
supported
rulesobject[]

The rules in this set. Shape varies by rule set kind: ordered network ACL rules carry rule_number, security group rules do not.

1 supported
Amazon Web Services
supported
15 properties
actionstring

Allow or deny. Always allow where the provider has no deny primitive.

all_portsboolean

Whether the rule covers every port, making the port range meaningless.

cidrsstring[]

Address ranges the rule matches.

descriptionstring

Free-text note carried on the rule.

directionstring

Whether the rule governs inbound or outbound traffic.

egressboolean

Set by network ACLs to mark an outbound rule.

from_portinteger

Lowest port in the range. For ICMP this is the type, not a port.

icmp_type_and_codestring

The ICMP type and code, where the protocol is ICMP.

ipv6_cidrsstring[]

IPv6 address ranges the rule matches. Kept separate from cidrs because a rule can carry both and the two are not interchangeable.

port_semanticsstring

How to read from_port and to_port: as ports, or as ICMP type and code.

prefix_list_idsstring[]

Provider-managed address lists the rule matches.

protocolstring

The protocol, or a value meaning all protocols.

rule_numberinteger

Evaluation order, where the provider orders rules. Absent for unordered rule sets.

source_group_idsstring[]

Other rule sets the rule matches, where the provider allows that.

to_portinteger

Highest port in the range. For ICMP this is the code, not a port.

scope_typestring

Which firewall primitive this is — the primitives have different semantics and available fields.

Possible values:
security_groupnetwork_aclfirewall_policyfirewall_ruleunknown
1 supported
Amazon Web Services
supported
supports_denyboolean

Whether this primitive can express a deny at all. False for AWS security groups (allow-only), where the rule's 'allow' action is a structural constant, not read from the provider.

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 firewallrulesets \
  -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',
  'firewallrulesets',
  { 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",
        "firewallrulesets",
        {"integrated_account_id": "<integrated_account_id>"}
    ):
        print(item)

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