Help us improve your experience.

Let us know what you think.

Do you have time for a two-minute survey?

Navigation
Guide That Contains This Content
[+] Expand All
[-] Collapse All

    Understanding the IP/MPLSView Networks API

    The networks API root is /IPMPLSView/API/v1/tenant/1/topology. It only allows GET requests. The live network is 1. Traffic data collection is only collected for the live network.

    The APIs related to nodes, links, tunnels, and interfaces are documented separately. Table 1 lists the network topology-related API categories.

    Object

    URL

    Description

    Topology List

    /

    Returns network topology information, including a list of network topologies.

    Topology Views

    /<topo_id>

    Returns the network topology of a view.

    Nodes

    /<topo_id>/nodes

    Returns network node information.

    Node

    /<topo_id>/nodes/<node_id>

    Returns details of a node.

    Links

    /<topo_id>/links

    Returns network link information.

    Link

    /<topo_id>/links/<link_id>

    Returns details of a link.

    Tunnels

    /<topo_id>/te-lsps

    Returns information about network tunnels.

    Tunnels per Node

    /<topo_id>/te-lsps/<node_name>

    Returns information about tunnels on a node.

    Single Tunnel

    /<topo_id>/te-lsps/<node_name>/<lsp_id>

    Returns details of a tunnel.

    Interfaces

    /<topo_id>/interfaces

    Returns details about network interfaces.

    Interfaces per Node

    /<topo_id>/interfaces/<node_name>

    Returns information about interfaces on a node.

    Single Interface

    /<topo_id>/interfaces/<node_name>/<interface_name>

    Returns information about an interface.

    Facilities

    /<topo_id>/facilities

    Returns details about network facilities.

    specBridge

    /<topo_id>/specBridge

    Returns a list of legacy spec files available in JSON format.

    Groups

    /<topo_id>/specBridge/groups

    Returns information about network groups.

    Group

    /<topo_id>/specBridge/groups/<group_name>

    Returns details of a group, including group members.

    Sites

    /<topo_id>/specBridge/sites

    Returns information about network sites.

    Site

    /<topo_id>/specBridge/sites/<site_name>

    Returns details of a site, including site members.

    Modified: 2017-04-05