# NetworkBoundaries Object

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

Schema for the `NetworkBoundaries` resource in **Unified Cloud Infrastructure API**.

## Properties

- **`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.
- **`boundary_ref`** _(string, required)_
  The provider's own identifier for the network.
- **`name`** _(string)_
  The network name.
- **`scope_type`** _(string, required)_
  Whether the network is regional or genuinely global.
  Allowed: `regional`, `global`
- **`is_global`** _(boolean)_
  True where the provider's network has no location at all. When true, the envelope region carries the literal string 'global' rather than a guessed region.
- **`cidr_ranges`** _(array<string>)_
  The address ranges the network covers.
- **`is_provider_default`** _(boolean, required)_
  Whether this is the provider's automatically created default network. Default networks are commonly permissive and are assessed separately.
- **`subnets`** _(array<object>)_
  Subnets inside this boundary, as objects carrying subnet_ref, location, cidr, auto_assign_public_ip, flow_logs_enabled, attached_rule_set_refs and has_route_to_internet. Nested rather than a separate resource because a subnet is only meaningful inside its boundary.
- **`attached_rule_set_refs`** _(array<string>)_
  Firewall rule sets attached at the boundary level.
- **`flow_logs_enabled`** _(boolean)_
  Whether traffic flow logging is on for this boundary. Flow logs attach at boundary, subnet or interface level and the provider returns them in one flat list keyed only by resource id, so matching on the subnet id alone gives false negatives for the very common single boundary-level flow log. Also gated on the log being ACTIVE and delivering successfully, since a flow log can exist and be silently failing delivery.
- **`flow_log_aggregation_interval_seconds`** _(integer)_
  How long the provider batches records before writing them. Carried under its honest name: it is a batching window, not a sampling fraction, and it is not substituted for flow_log_sampling_rate.
- **`flow_log_sampling_rate`** _(number)_
  What fraction of traffic is actually captured, where a provider samples. Matters as much as the enabled flag, since a very low rate is technically enabled and evidentially useless. AWS VPC Flow Logs have no sampling rate at all -- no field and no setting -- so on AWS this is null with not_supported_by_provider. Related honest caveat: AWS flow logs never capture DNS, instance metadata, DHCP or ARP traffic by design, and AWS documents non-deterministic record loss under capacity pressure.
- **`has_route_to_internet`** _(boolean)_
  Whether the boundary can reach the internet. Computed, and easy to get wrong: a subnet not explicitly associated with a route table is IMPLICITLY associated with the boundary's main table and the provider does not return the subnet id for implicit associations, so joining on explicit associations alone marks every default-configured subnet as having no internet route.
- **`internet_route_type`** _(string)_
  What kind of internet path exists. A gateway giving inbound reachability is a different finding from an outbound-only NAT path, and the two are not collapsed.
  Allowed: `none`, `internet_gateway`, `nat_only`, `ipv6_egress_only`, `unknown`
- **`block_public_access_state`** _(string)_
  Whether a boundary-wide public-access block overrides the routing. A boundary can hold an internet gateway route and still be unreachable because of this setting, so it is read before has_route_to_internet is reported as a finding.

## Methods

- [GET /unified/cloud-infrastructure/network_boundaries](/docs/api-reference/unified-cloud-infrastructure-api/networkboundaries/list) — List Network boundaries