List Networks
GET /v2.0/networks
Default policy settings return only networks that the project who submits the request owns, unless an administrative user submits the request. In addition, networks shared with the project who submits the request are also returned.
info
Source: list-networks
Request
Query parameters
| Name | Type | Description |
|---|---|---|
admin_state_up (Optional) | boolean | Filter by administrative state: up (true) or down (false). |
id (Optional) | string | Filter by network ID. |
mtu (Optional) | integer | Filter by MTU. Minimum 68 (IPv4) or 1280 (IPv6). |
name (Optional) | string | Filter by name. |
project_id (Optional) | string | Filter by owning project ID. |
provider:network_type (Optional) | string | Filter by provider network type (e.g., flat, vlan, vxlan, gre). |
provider:physical_network (Optional) | string | Filter by physical network. |
provider:segmentation_id (Optional) | integer | Filter by provider segmentation ID. |
revision_number (Optional) | integer | Filter by revision number. |
router:external (Optional) | boolean | Filter by whether network is external. |
shared (Optional) | boolean | Filter by whether network is shared. |
status (Optional) | string | Filter by status: ACTIVE, DOWN, BUILD, ERROR. |
tenant_id (Optional) | string | Filter by owning project ID. |
vlan_transparent (Optional) | boolean | Filter by VLAN transparency mode. |
description (Optional) | string | Filter by description. |
is_default (Optional) | boolean | Filter by whether network is default pool. |
tags (Optional) | string | Comma-separated list; matches resources with all tags. |
tags-any (Optional) | string | Comma-separated list; matches resources with any tag. |
not-tags (Optional) | string | Comma-separated list; excludes resources matching all tags. |
not-tags-any (Optional) | string | Comma-separated list; excludes resources matching any tag. |
sort_dir (Optional) | string | Sort direction: asc or desc. Can be repeated with sort_key. |
sort_key (Optional) | string | Sort by attribute. Allowed: admin_state_up, availability_zone_hints, id, mtu, name, status, tenant_id, project_id. |
fields (Optional) | string | Returned fields. Can be specified multiple times (e.g., fields=id&fields=name). |
Example request
Using curl
curl -ks -H 'Content-Type: application/json' \
-H 'X-Auth-Token: gAAAAA<...>' \
https://api.vietnix.cloud:9696/v2.0/networks
Using HTTP request
GET https://api.vietnix.cloud:9696/v2.0/networks
Response
Parameters
| Name | Type | Description |
|---|---|---|
networks | array | List of network objects. |
admin_state_up | boolean | Administrative state: up (true) or down (false). |
availability_zone_hints | array | Availability zone candidates. Current VHI returns default or null. |
availability_zones | array | Availability zones. Current VHI returns default or null. |
created_at | string | Creation time (ISO 8601). |
dns_domain | string | DNS domain. |
id | string | Network ID. |
ipv4_address_scope | string | IPv4 address scope ID. |
ipv6_address_scope | string | IPv6 address scope ID. |
l2_adjacency | boolean | Whether L2 connectivity is available throughout the network. |
mtu | integer | Maximum transmission unit. |
name | string | Human-readable name. |
port_security_enabled | boolean | Port security status (default for new ports). |
project_id | string | Owning project ID. |
provider:network_type | string | Provider network type (e.g., flat, vlan, vxlan, gre). |
provider:physical_network | string | Physical network. |
provider:segmentation_id | integer | Provider segmentation identifier. |
qos_policy_id | string | Associated QoS policy ID. |
revision_number | integer | Revision number. |
router:external | boolean | Whether network is external. |
segments | array | List of provider segment objects. |
shared | boolean | Whether network is shared across tenants. |
status | string | Network status: ACTIVE, DOWN, BUILD, ERROR. |
subnets | array | Associated subnet IDs. |
tenant_id | string | Owning project ID. |
updated_at | string | Last update time (ISO 8601) or null. |
vlan_transparent | boolean | VLAN transparency mode. |
default_vnic_type | string | Default vnic_type for ports in this network. |
description | string | Human-readable description. |
is_default | boolean | Whether network is default pool. |
tags | array | List of resource tags. |
Sample Response
{
"networks": [
{
"id": "4cda9d1d-a3a6-40cb-a276-682bc4f4d774",
"name": "test03",
"tenant_id": "f33507157a634f1cac71e06a70fb558e",
"admin_state_up": true,
"mtu": 8913,
"default_vnic_type": null,
"status": "ACTIVE",
"subnets": [
"1d4cbc73-1a4e-4b37-86f8-ab09cec02e87"
],
"shared": false,
"availability_zone_hints": [],
"availability_zones": [
"nova"
],
"ipv4_address_scope": null,
"ipv6_address_scope": null,
"router:external": false,
"description": "",
"port_security_enabled": true,
"rbac_policies": [],
"qos_policy_id": "dfc42ced-02c8-4b1f-bbe6-14cc014f259d",
"tags": [],
"created_at": "2025-09-17T02:48:19Z",
"updated_at": "2025-09-17T02:48:19Z",
"revision_number": 2,
"project_id": "f33507157a634f1cac71e06a70fb558e",
"provider:network_type": "vxlan"
},
{
"id": "568e8929-249c-4e5c-afb5-ff72914ac3ca",
"name": "test02",
"tenant_id": "f33507157a634f1cac71e06a70fb558e",
"admin_state_up": true,
"mtu": 8913,
"default_vnic_type": null,
"status": "ACTIVE",
"subnets": [
"a83b46c4-0489-49fa-a037-487d761ff107"
],
"shared": false,
"availability_zone_hints": [],
"availability_zones": [
"nova"
],
"ipv4_address_scope": null,
"ipv6_address_scope": null,
"router:external": false,
"description": "",
"port_security_enabled": true,
"rbac_policies": [],
"qos_policy_id": "dfc42ced-02c8-4b1f-bbe6-14cc014f259d",
"tags": [],
"created_at": "2025-09-17T02:53:25Z",
"updated_at": "2025-09-17T02:53:25Z",
"revision_number": 2,
"project_id": "f33507157a634f1cac71e06a70fb558e",
"provider:network_type": "vxlan"
},
{
"id": "79cab11a-122d-43a7-9427-3575d9512413",
"name": "FLOATING_45_115_16_0_24_VLAN102",
"tenant_id": "a430f930af8e47d7a1820a477129c343",
"admin_state_up": true,
"mtu": 1500,
"default_vnic_type": null,
"status": "ACTIVE",
"subnets": [
"18847364-07d0-48c8-a175-6dc839ae737e",
"54ca4e27-7dfd-4504-a36b-8c47527f7a23"
],
"shared": false,
"availability_zone_hints": [],
"availability_zones": [
"nova"
],
"ipv4_address_scope": null,
"ipv6_address_scope": null,
"router:external": true,
"description": "",
"port_security_enabled": true,
"rbac_policies": [
{
"id": "ff6ed553-4bdc-4ac6-9e7e-230e71cbcaf7",
"action": "access_as_external",
"target_tenant": "*"
}
],
"qos_policy_id": null,
"is_default": false,
"tags": [],
"created_at": "2025-08-25T05:51:46Z",
"updated_at": "2025-09-04T06:23:26Z",
"revision_number": 7,
"project_id": "a430f930af8e47d7a1820a477129c343",
"provider:network_type": "vlan"
},
{
"id": "8ae2b710-ad3d-469e-a75a-c3e203887d2e",
"name": "test01",
"tenant_id": "f33507157a634f1cac71e06a70fb558e",
"admin_state_up": true,
"mtu": 8913,
"default_vnic_type": null,
"status": "ACTIVE",
"subnets": [
"7e35a1a1-ffcd-48a4-82c2-39836d2add00"
],
"shared": false,
"availability_zone_hints": [],
"availability_zones": [
"nova"
],
"ipv4_address_scope": null,
"ipv6_address_scope": null,
"router:external": false,
"description": "",
"port_security_enabled": true,
"rbac_policies": [],
"qos_policy_id": "dfc42ced-02c8-4b1f-bbe6-14cc014f259d",
"tags": [],
"created_at": "2025-09-17T02:52:19Z",
"updated_at": "2025-09-17T02:52:19Z",
"revision_number": 2,
"project_id": "f33507157a634f1cac71e06a70fb558e",
"provider:network_type": "vxlan"
}
]
}
Status codes
Success
| Status Code | Description |
|---|---|
| 200 - OK | Request was successful. |
Error
| Status Code | Description |
|---|---|
| 401 - Unauthorized | User must authenticate before making a request. |
| 403 - Forbidden | Policy does not allow current user to do this operation. |