createOrgNetwork
Create an organization network definition with subnet, gateway, VLAN, access, NAT, multicast, tenant, and VPN access settings used for service routes and gateway or network template configuration.
Networks can be used
- in the gateway configuration to define Layer 3 network settings and policies for traffic entering or leaving the gateway through a specific interface, such as a corporate LAN, guest Wi-Fi, or DMZ network.
- in the service policies to allow or deny traffic matching the network or to apply specific inspection settings or steering rules.
Preferred authentication method for automation and integrations. Send the API token in the HTTP Authorization header.
Format:
Authorization: Token {apitoken}
Notes:
- An API token generated for a specific admin has the same privileges as that admin
- An API token is automatically removed if it is not used for more than 90 days
- SSO admins cannot generate admin API tokens. Use organization API tokens when scoped Org/Site privileges are needed.
In: header
Path Parameters
uuidRequest Body
application/json
Organization-level Layer 3 network definition that can be merged into site settings and used for service routes. Networks are used to define the service routes in the Gateway settings or templates
Whether to disallow Mist Devices in the network
falseIPv4 gateway address for this network
ipv4IPv6 gateway address for this network
ipv6Internal access settings for this network
Direct internet access and NAT settings for this network
Whether to allow clients in the network to talk to each other
Settings for multicast routing on this network
Display name of the organization network
Other network names this network can route to, for example through BGP, OSPF or static routes
IPv4 subnet CIDR for this network
IPv6 subnet CIDR for this network
Tenant address mappings associated with this network
VLAN ID or variable associated with this network
VPN access settings keyed by VPN name for this network
SecurityZone this network belongs to. When set, the zone name is used as the security zone name on the SRX, and multiple networks can share the same zone. When omitted, the network name is used as the security zone name.
uuidResponse Body
curl -X POST "https://example.com/api/v1/orgs/000000ab-00ab-00ab-00ab-0000000000ab/networks" \ -H "Content-Type: application/json" \ -d '{ "disallow_mist_services": false, "gateway": "192.168.70.1", "hosts": { "property1": { "external_ips": "172.16.10.32-172.16.10.35", "ips": "192.168.70.32-192.168.70.35" }, "property2": { "external_ips": "172.16.10.32-172.16.10.35", "ips": "192.168.70.32-192.168.70.35" } }, "internal_access": { "enabled": true }, "internet_access": { "create_simple_service_policy": false, "destination_nat": { "property1": { "internal_ip": "192.168.70.30", "name": "web server", "port": "443" }, "property2": { "internal_ip": "192.168.70.30", "name": "web server", "port": "443" } }, "enabled": true, "restricted": false, "static_nat": { "property1": { "internal_ip": "192.168.70.3", "name": "printer-1" }, "property2": { "internal_ip": "192.168.70.3", "name": "printer-1" } } }, "isolation": true, "name": "string", "subnet": "192.168.70.0/24", "tenants": { "property1": { "addresses": [ "10.10.10.10." ] }, "property2": { "addresses": [ "10.10.10.52" ] } }, "vlan_id": 10, "vpn_access": { "property1": { "allow_ping": true, "destination_nat": { "property1": { "internal_ip": "192.168.70.5/30", "name": "web server", "port": "443" }, "property2": { "internal_ip": "192.168.70.5/30", "name": "web server", "port": "443" } }, "nat_pool": "172.16.0.0/26", "routed": true, "source_nat": { "external_ip": "172.16.0.8/30" }, "static_nat": { "property1": { "internal_ip": "192.168.70.3", "name": "pos_station-1" }, "property2": { "internal_ip": "192.168.70.3", "name": "pos_station-1" } }, "summarized_subnet": "172.16.0.0/16" }, "property2": { "allow_ping": true, "destination_nat": { "property1": { "internal_ip": "192.168.70.5/30", "name": "web server", "port": "443" }, "property2": { "internal_ip": "192.168.70.5/30", "name": "web server", "port": "443" } }, "nat_pool": "172.16.0.0/26", "routed": true, "source_nat": { "external_ip": "172.16.0.8/30" }, "static_nat": { "property1": { "internal_ip": "192.168.70.3", "name": "pos_station-1" }, "property2": { "internal_ip": "192.168.70.3", "name": "pos_station-1" } }, "summarized_subnet": "172.16.0.0/16" } } }'{ "created_time": 0, "disallow_mist_services": false, "gateway": "192.168.70.1", "hosts": { "property1": { "external_ips": "172.16.10.32-172.16.10.35", "ips": "192.168.70.32-192.168.70.35" }, "property2": { "external_ips": "172.16.10.32-172.16.10.35", "ips": "192.168.70.32-192.168.70.35" } }, "id": "497f6eca-6276-4993-bfeb-53cbbbba6f12", "internal_access": { "enabled": true }, "internet_access": { "create_simple_service_policy": false, "destination_nat": { "property1": { "internal_ip": "192.168.70.30", "name": "web server", "port": "443" }, "property2": { "internal_ip": "192.168.70.30", "name": "web server", "port": "443" } }, "enabled": true, "restricted": false, "static_nat": { "property1": { "internal_ip": "192.168.70.3", "name": "printer-1" }, "property2": { "internal_ip": "192.168.70.3", "name": "printer-1" } } }, "isolation": true, "modified_time": 0, "name": "string", "org_id": "a40f5d1f-d889-42e9-94ea-b9b33585fc6b", "subnet": "192.168.70.0/24", "tenants": { "property1": { "addresses": [ "10.10.10.10" ] }, "property2": { "addresses": [ "10.10.10.52" ] } }, "vlan_id": 10, "vpn_access": { "property1": { "allow_ping": true, "destination_nat": { "property1": { "internal_ip": "192.168.70.5/30", "name": "web server", "port": "443" }, "property2": { "internal_ip": "192.168.70.5/30", "name": "web server", "port": "443" } }, "nat_pool": "172.16.0.0/26", "routed": true, "source_nat": { "external_ip": "172.16.0.8/30" }, "static_nat": { "property1": { "internal_ip": "192.168.70.3", "name": "pos_station-1" }, "property2": { "internal_ip": "192.168.70.3", "name": "pos_station-1" } }, "summarized_subnet": "172.16.0.0/16" }, "property2": { "allow_ping": true, "destination_nat": { "property1": { "internal_ip": "192.168.70.5/30", "name": "web server", "port": "443" }, "property2": { "internal_ip": "192.168.70.5/30", "name": "web server", "port": "443" } }, "nat_pool": "172.16.0.0/26", "routed": true, "source_nat": { "external_ip": "172.16.0.8/30" }, "static_nat": { "property1": { "internal_ip": "192.168.70.3", "name": "pos_station-1" }, "property2": { "internal_ip": "192.168.70.3", "name": "pos_station-1" } }, "summarized_subnet": "172.16.0.0/16" } }}listOrgNetworks GET
List organization-level Layer 3 network definitions used for service routes and gateway or network template configuration.
getOrgNetwork GET
Retrieve details for a specific organization network, including subnet, gateway, VLAN, access, NAT, multicast, tenant, and VPN access settings.