ForwardingRule Schema

Data structure for Forwarding Rule objects.

Fields

Field	Type	Required	Description	Notes
`access_control`	string	No	-	API field: `access_control`
`app_service_groups`	EntityReferenceWrapperCollection	No	-	API field: `app_service_groups`
`block_response_code`	string	No	-	API field: `block_response_code`
`dedicated_IP_gateway`	EntityReference	No	-	API field: `dedicated_IP_gateway`
`departments`	EntityReferenceWrapperCollection	No	-	-
`description`	string	No	-	-
`dest_addresses`	stringCollection	No	-	API field: `dest_addresses`
`dest_countries`	DestCountriesEnumCollection	No	-	API field: `dest_countries`
`dest_ip_categories`	stringCollection	No	-	API field: `dest_ip_categories`
`dest_ip_groups`	EntityReferenceWrapperCollection	No	-	API field: `dest_ip_groups`
`dest_ipv6_groups`	EntityReferenceWrapperCollection	No	-	API field: `dest_ipv6_groups`
`dest_workload_groups`	EntityReferenceWrapperCollection	No	-	API field: `dest_workload_groups`
`device_groups`	EntityReferenceWrapperCollection	No	-	API field: `device_groups`
`devices`	EntityReferenceWrapperCollection	No	-	-
`ec_groups`	EntityReferenceWrapperCollection	No	-	API field: `ec_groups`
`end_point_application_groups`	EndPointApplicationGroupWrapperCollection	No	-	API field: `end_point_application_groups`
`end_point_application_threat_levels`	ThreatLevelEnumCollection	No	-	API field: `end_point_application_threat_levels`
`end_point_applications`	EndPointApplicationLiteWrapperCollection	No	-	API field: `end_point_applications`
`exclude_context_shield_end_point`	boolean	No	-	API field: `exclude_context_shield_end_point`
`forward_method`	string	Yes	-	API field: `forward_method`
`groups`	EntityReferenceWrapperCollection	No	-	-
`id`	integer	No	-	-
`labels`	EntityReferenceWrapperCollection	No	-	-
`last_modified_by`	EntityReference	No	-	API field: `last_modified_by`
`last_modified_time`	integer	No	-	API field: `last_modified_time`
`location_groups`	EntityReferenceWrapperCollection	No	-	API field: `location_groups`
`locations`	EntityReferenceWrapperCollection	No	-	-
`name`	string	Yes	-	-
`nw_application_groups`	EntityReferenceWrapperCollection	No	-	API field: `nw_application_groups`
`nw_applications`	NwApplicationsEnumCollection	No	-	API field: `nw_applications`
`nw_service_groups`	EntityReferenceWrapperCollection	No	-	API field: `nw_service_groups`
`nw_services`	EntityReferenceWrapperCollection	No	-	API field: `nw_services`
`order`	integer	No	-	-
`proxy_gateway`	EntityReference	No	-	API field: `proxy_gateway`
`rank`	integer	Yes	-	-
`res_categories`	stringCollection	No	-	API field: `res_categories`
`source_countries`	DestCountriesEnumCollection	No	-	API field: `source_countries`
`source_ip_group_exclusion`	boolean	No	-	API field: `source_ip_group_exclusion`
`source_ip_group_exclusion_flag`	boolean	No	-	API field: `source_ip_group_exclusion_flag`
`src_ip_groups`	EntityReferenceWrapperCollection	No	-	API field: `src_ip_groups`
`src_ips`	stringCollection	No	-	API field: `src_ips`
`src_ipv6_groups`	EntityReferenceWrapperCollection	No	-	API field: `src_ipv6_groups`
`src_workload_groups`	EntityReferenceWrapperCollection	No	-	API field: `src_workload_groups`
`state`	string	No	-	-
`template_synced_rule_flag`	string	No	-	API field: `template_synced_rule_flag`
`time_windows`	EntityReferenceWrapperCollection	No	-	API field: `time_windows`
`type`	string	No	-	-
`users`	EntityReferenceWrapperCollection	No	-	-
`wan_selection`	string	No	-	API field: `wan_selection`
`zpa_app_segments`	AppSegmentWrapperCollection	No	-	API field: `zpa_app_segments`
`zpa_application_segment_groups`	ZpaApplicationSegmentGroupWrapperCollection	No	-	API field: `zpa_application_segment_groups`
`zpa_application_segments`	ZpaApplicationSegmentWrapperCollection	No	-	API field: `zpa_application_segments`
`zpa_broker_rule`	boolean	No	-	API field: `zpa_broker_rule`
`zpa_gateway`	EntityReference	No	-	API field: `zpa_gateway`

Example

{
  "access_control": "string",
  "app_service_groups": [
    {
      "association_time": 123,
      "deleted": true,
      "extensions": {
        "id": "object-id"
      }
    }
  ],
  "block_response_code": "string",
  "dedicated_IP_gateway": {
    "association_time": 123,
    "deleted": true,
    "extensions": {
      "id": "object-id"
    }
  },
  "departments": [
    {
      "association_time": 123,
      "deleted": true,
      "extensions": {
        "id": "object-id"
      }
    }
  ],
  "description": "string",
  "dest_addresses": [
    "value"
  ],
  "dest_countries": [
    "value"
  ]
}
// ... more fields

Fields​

Example​

Fields

Example