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

admin_state_upboolean

Filter by administrative state: up (true) or down (false).

idstring

Filter by network ID.

mtuinteger

Filter by MTU. Minimum 68 (IPv4) or 1280 (IPv6).

namestring

Filter by name.

project_idstring

Filter by owning project ID.

provider:network_typestring

Filter by provider network type (e.g., flat, vlan, vxlan, gre).

provider:physical_networkstring

Filter by physical network.

provider:segmentation_idinteger

Filter by provider segmentation ID.

revision_numberinteger

Filter by revision number.

router:externalboolean

Filter by whether network is external.

sharedboolean

Filter by whether network is shared.

statusstring

Filter by status: ACTIVE, DOWN, BUILD, ERROR.

tenant_idstring

Filter by owning project ID.

vlan_transparentboolean

Filter by VLAN transparency mode.

descriptionstring

Filter by description.

is_defaultboolean

Filter by whether network is default pool.

tagsstring

Comma-separated list; matches resources with all tags.

tags-anystring

Comma-separated list; matches resources with any tag.

not-tagsstring

Comma-separated list; excludes resources matching all tags.

not-tags-anystring

Comma-separated list; excludes resources matching any tag.

sort_dirstring

Sort direction: asc or desc. Can be repeated with sort_key.

sort_keystring

Sort by attribute. Allowed: admin_state_up, availability_zone_hints, id, mtu, name, status, tenant_id, project_id.

fieldsstring

Returned fields. Can be specified multiple times (e.g., fields=id&fields=name).

Example request

cURL
HTTP

curl -ks -H 'Content-Type: application/json' \
  -H 'X-Auth-Token: gAAAAA<...>' \
  https://api.vietnix.cloud:9696/v2.0/networks

GET https://api.vietnix.cloud:9696/v2.0/networks

Response

Parameters

networksarrayrequired

List of network objects.

admin_state_upbooleanrequired

Administrative state: up (true) or down (false).

availability_zone_hintsarrayrequired

Availability zone candidates. Current VHI returns default or null.

availability_zonesarrayrequired

Availability zones. Current VHI returns default or null.

created_atstringrequired

Creation time (ISO 8601).

dns_domainstringrequired

DNS domain.

idstringrequired

Network ID.

ipv4_address_scopestringrequired

IPv4 address scope ID.

ipv6_address_scopestringrequired

IPv6 address scope ID.

l2_adjacencybooleanrequired

Whether L2 connectivity is available throughout the network.

mtuintegerrequired

Maximum transmission unit.

namestringrequired

Human-readable name.

port_security_enabledbooleanrequired

Port security status (default for new ports).

project_idstringrequired

Owning project ID.

provider:network_typestringrequired

Provider network type (e.g., flat, vlan, vxlan, gre).

provider:physical_networkstringrequired

Physical network.

provider:segmentation_idintegerrequired

Provider segmentation identifier.

qos_policy_idstringrequired

Associated QoS policy ID.

revision_numberintegerrequired

Revision number.

router:externalbooleanrequired

Whether network is external.

segmentsarrayrequired

List of provider segment objects.

sharedbooleanrequired

Whether network is shared across tenants.

statusstringrequired

Network status: ACTIVE, DOWN, BUILD, ERROR.

subnetsarrayrequired

Associated subnet IDs.

tenant_idstringrequired

Owning project ID.

updated_atstringrequired

Last update time (ISO 8601) or null.

vlan_transparentbooleanrequired

VLAN transparency mode.

default_vnic_typestringrequired

Default vnic_type for ports in this network.

descriptionstringrequired

Human-readable description.

is_defaultbooleanrequired

Whether network is default pool.

tagsarrayrequired

List of resource tags.

Sample Response

Response body

{
    "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.

Request​

Query parameters​

Example request​

Response​

Parameters​

Sample Response​

Status codes​

Success​

Error​