# List Firewall rule sets

> Source: https://truto.one/docs/api-reference/unified-cloud-infrastructure-api/firewallrulesets/list/

`GET /unified/cloud-infrastructure/firewall_rule_sets`

Resource: **FirewallRuleSets** · API: **Unified Cloud Infrastructure API**

## Supported integrations

Amazon Web Services

## Query parameters

- **`integrated_account_id`** _(string, required)_
  The ID of the integrated account to use for the request.
- **`truto_response_format`** _(string)_
  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`.
  Allowed: `unified`, `raw`, `normalized`, `stream`, `debug`
- **`truto_key_by`** _(string)_
  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.
- **`truto_ignore_limit`** _(boolean)_
  Ignores the `limit` query parameter.
- **`truto_ignore_remote_data`** _(boolean)_
  Excludes the `remote_data` attribute from the response.
- **`truto_exclude_fields`** _(array<string>)_
  Array of fields to exclude from the response.
- **`remote_query`** _(object)_
  Query parameters to pass to the underlying API without any transformations. Refer [this guide](https://truto.one/docs/api-reference/overview/querying#remote-query-parameters) to see how to structure the query parameters.
- **`scope_type`** _(string)_
  Security groups and NACLs are genuinely different primitives - stateful/allow-only/unordered/ENI-attached versus stateless/allow-deny/ordered/subnet-attached - so they are read separately rather than papered over. Both must be called for full coverage.
  Allowed: `firewall_policy`, `firewall_rule`, `network_acl`, `security_group`, `unknown`

## Response body

- **`result`** _(array<object>)_
  List of Firewall rule sets
  - **`id`** _(string, required)_
    Truto's stable unified identifier for this object. Opaque; use provider_ref to address the object in the provider's own console or API.
  - **`provider_ref`** _(string, required)_
    The provider's own unbroken identifier, passed through verbatim -- a full ARN, resource id or self-link. Never truncated, prefixed or normalised. This is the customer-facing key used to find the object in the console.
  - **`provider`** _(string, required)_
    Which cloud this object was read from.
    Allowed: `aws`, `azure`, `gcp`
  - **`account_ref`** _(string, required)_
    The account, subscription or project the object belongs to. An object with no account cannot be attributed to an environment, so this is always present for objects that live inside an account.
  - **`region`** _(string)_
    Where the object is. A compliance answer in its own right, not metadata. The literal string 'global' is emitted for genuinely global resources (for example IAM, or a GCP VPC network) rather than guessing a region. Never invented: where the provider does not return a location and none can be derived, the collector's queried region is used and that substitution is recorded in unreadable_fields.
  - **`native_type`** _(string, required)_
    The provider's own type string, unmodified -- for example 'AWS::S3::Bucket', 'aws_iam_role', 'Microsoft.Sql/servers'. Used for display and drill-down.
  - **`tags`** _(object)_
    Key-value pairs exactly as the customer set them: no case folding, no key or value normalisation, no merging of separate provider concepts. Present on every object because tags are the primary input for environment classification. An empty object means the object carries no tags; tags that could not be read are recorded in unreadable_fields instead.
  - **`collected_at`** _(string, required)_
    When Truto actually read this object from the provider, in UTC ISO 8601 with the offset present. Not when the request was made and not a provider timestamp. Drives consumer staleness rules.
  - **`unreadable_fields`** _(array<object>)_
    Per-object list of the fields that could not be read, and why -- the brief section 8.4 answer, chosen over per-field sentinel values. Each entry is an object with 'field' (the property name on this resource), 'reason' (a reason code) and an optional human-readable 'detail'. Reason codes: not_supported_by_provider, not_configured, permission_denied, not_collected, collection_error, partially_collected. An empty array means every property on this object was read successfully. A property absent from this array and null in the payload means the provider genuinely returned no value, which is different from 'we could not look'.
  - **`remote_data`** _(object)_
    Raw data returned from the remote API call.
  - **`rule_set_ref`** _(string, required)_
    The provider's own identifier for the rule set.
  - **`name`** _(string, required)_
    The rule set name.
  - **`scope_type`** _(string, required)_
    Which firewall primitive this is. Emitted as a real discriminator rather than papering over the difference, because the primitives have different semantics and different available fields.
    Allowed: `security_group`, `network_acl`, `firewall_policy`, `firewall_rule`, `unknown`
  - **`is_stateful`** _(boolean)_
    Whether return traffic is implicitly allowed.
  - **`supports_deny`** _(boolean)_
    Whether this primitive can express a deny at all. False for AWS security groups, which are allow-only, so the 'allow' action on their rules is a structural constant and not something the provider told us.
  - **`is_ordered`** _(boolean)_
    Whether rule order determines evaluation. False for AWS security groups, whose rules are an unordered set evaluated as a union -- which is why no priority is fabricated from array position.
  - **`attached_to`** _(array<object>)_
    What this rule set is attached to, as objects carrying the target reference and its type. For AWS security groups the attachment is not in the provider's model at all: it is observed by listing network interfaces and joining, which makes it 'groups observed in use right now' rather than configuration -- an autoscaling event changes it.
  - **`attached_boundary_ref`** _(string)_
    The network boundary this rule set belongs to.
  - **`observed_attachment_only`** _(boolean)_
    True when attached_to was observed from live interfaces rather than read from configuration, so the consumer does not treat a point-in-time observation as a stable fact.
  - **`rules`** _(array<object>)_
    The rules in this set, as objects. Each rule carries direction, action, protocol, port_range, source_ranges, destination_ranges, target_selector, priority, description, enabled and logging_enabled. Four of those are not real for AWS security groups and are marked in unreadable_fields rather than fabricated: action is a constant because the primitive is allow-only, priority does not exist because rules are unordered, no per-rule enabled state exists, and no per-rule logging exists. target_selector matters where a provider selects targets by tag or service identity rather than by attachment, making 'which rules apply to this machine' a computed answer. Note that a protocol meaning 'all' makes any accompanying port range meaningless, and for ICMP the two port numbers are type and code rather than ports. An empty array means the set genuinely has no rules.
  - **`rule_count`** _(integer)_
    How many rules this set contains.
  - **`descriptions_supported`** _(boolean)_
    Whether this primitive carries a per-rule description at all. One standard asks whether each rule has a documented business reason, and the answer must distinguish 'the rule has no description' from 'this primitive has no description field' -- AWS security group rules have one, network ACL entries do not.
  - **`has_open_ingress_from_anywhere`** _(boolean)_
    Whether any rule permits inbound traffic from the whole internet. Derived.
- **`next_cursor`** _(string)_
  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.
- **`debug`** _(object)_
  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`.
  - **`requestUrl`** _(string)_
  - **`requestOptions`** _(object)_
  - **`data`** _(unknown)_
  - **`responseHeaders`** _(object)_
  - **`nextCursor`** _(string)_
  - **`isLooping`** _(boolean)_
  - **`isEmptyResult`** _(boolean)_
  - **`resultCount`** _(number)_

## Code examples

### Truto CLI

```bash
truto unified cloud-infrastructure firewallrulesets \
  -a '<integrated_account_id>' \
  -o json
```

### Truto TS SDK

```typescript
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);
```

### Truto Python SDK

```python
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

```bash
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'
```

### JavaScript

```javascript
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);
```

### Python

```python
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())
```