Add subnet filtering API updates

githedgehog · Feb 8, 2024 · e8f5bcb · e8f5bcb
1 parent 932caef
commit e8f5bcb
Showing 1 changed file with 7 additions and 2 deletions.
diff --git a/docs/reference/api.md b/docs/reference/api.md
@@ -611,8 +611,11 @@ _Appears in:_
 | Field | Description |
 | --- | --- |
 | `subnets` _object (keys:string, values:[VPCSubnet](#vpcsubnet))_ | Subnets is the list of VPC subnets to configure |
-| `ipv4Namespace` _string_ | IPv4Namespace is the name of the IPv4Namespace this VPC belongs to |
-| `vlanNamespace` _string_ | VLANNamespace is the name of the VLANNamespace this VPC belongs to |
+| `ipv4Namespace` _string_ | IPv4Namespace is the name of the IPv4Namespace this VPC belongs to (if not specified, "default" is used) |
+| `vlanNamespace` _string_ | VLANNamespace is the name of the VLANNamespace this VPC belongs to (if not specified, "default" is used) |
+| `defaultIsolated` _boolean_ | DefaultIsolated sets default bahivour for isolated mode for the subnets (disabled by default) |
+| `defaultRestricted` _boolean_ | DefaultRestricted sets default bahivour for restricted mode for the subnets (disabled by default) |
+| `permit` _string array array_ | Permit defines a list of the access policies between the subnets within the VPC - each policy is a list of subnets that have access to each other. It's applied on top of the subnet isolation flag and if subnet isn't isolated it's not required to have it in a permit list while if vpc is marked as isolated it's required to have it in a permit list to have access to other subnets. |
 
 
 #### VPCStatus
@@ -640,6 +643,8 @@ _Appears in:_
 | `subnet` _string_ | Subnet is the subnet CIDR block, such as "10.0.0.0/24", should belong to the IPv4Namespace and be unique within the namespace |
 | `dhcp` _[VPCDHCP](#vpcdhcp)_ | DHCP is the on-demand DHCP configuration for the subnet |
 | `vlan` _string_ | VLAN is the VLAN ID for the subnet, should belong to the VLANNamespace and be unique within the namespace |
+| `isolated` _boolean_ | Isolated is the flag to enable isolated mode for the subnet which means no access to and from the other subnets within the VPC |
+| `restricted` _boolean_ | Restricted is the flag to enable restricted mode for the subnet which means no access between hosts within the subnet itself |