Show Network Details

GET /v2.0/networks/{network_id}

Shows the details of a network with the specified ID.

info

Source: show-network-details

Request

Path parameters

Name	Type	Description
network_id	string	The ID of the network.

Query parameters

Name	Type	Description
fields (Optional)	string	Fields to return. Can be specified multiple times, e.g. fields=id&fields=name. If omitted, all attributes allowed by policy are returned.

Example request

Using curl

curl -ks -H 'Content-Type: application/json' \
  -H 'X-Auth-Token: gAAAAA<...>' \
  https://api.vietnix.cloud:9696/v2.0/networks/170546a1-a70a-40af-93e2-9261c7c05b77

Using HTTP request

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

Response

Parameters

Name	Type	Description
network	object	A network object.
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. Minimum 68 (IPv4) or 1280 (IPv6).
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

{
    "network": {
        "id": "170546a1-a70a-40af-93e2-9261c7c05b77",
        "name": "privnet1",
        "tenant_id": "f33507157a634f1cac71e06a70fb558e",
        "admin_state_up": true,
        "mtu": 1413,
        "default_vnic_type": null,
        "status": "ACTIVE",
        "subnets": [
            "d3f93e1c-f59d-40f8-a46c-ea6285f3a069"
        ],
        "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-23T06:42:18Z",
        "updated_at": "2025-09-23T07:00:56Z",
        "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.
404 - Not Found	The requested resource could not be found.