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

network_idstringrequired

The ID of the network.

Query parameters

fieldsstring

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

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

HTTP

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

Response

Parameters

networkobjectrequired

A network object.

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. Minimum 68 (IPv4) or 1280 (IPv6).

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

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