Get Topology Vertices and Edges
get
/api/graph/Graphs/read
Gets the topology vertices and edges that match the specified query parameters.
Request
Query Parameters
-
EndVertexID: string
The end vertex ID.Example:
b1e9b185-5f05-4e41-8031-e9f7586a88f9
-
EndVertexName: string
The end vertex name.Example:
vertex.example.com
-
GraphType(required): string
The graph type. Possible values are:
- VertexList: Get information based on a starting vertex and either an end vertex or a number of hops. Specify the StartVertexID or StartVertexName parameter and the EndVertexID, EndVertexName or Hops parameters.
- VertexProperty: Get information based on a specific vertex property.
- EdgeProperty: Get information based on a specific edge property.
Example:VertexList
-
Hops: integer(int32)
The number of hops (links) to follow.Example:
1
-
Layout(required): string
The layout type.Example:
Tree
-
StartVertexID: string
The start vertex ID.Example:
b1e9b165-5f05-4e41-8031-e9f7586a88f9
-
StartVertexName: string
The start vertex name.Example:
router.example.com
-
StartVertexPath(required): string
The path to the start vertex.Example:
//Root//Self Monitoring (Manual Thresholds)
-
VertexGroupByTypeName:
The group by vertex type name.Example:
Any
-
VertexTuckAwayTypeName:
The tuck away vertex type name.Example:
Interface
-
ViewEdgeTypes: string
The list of edge types to get. Use Any to get all edge types.Example:
Any
-
ViewVertexTypes: array[]
The list of vertex types to get. Use Any to get all vertex types.Example:
Any
There's no request body for this operation.
Back to TopResponse
Supported Media Types
- application/json
200 Response
Successful operation
Nested Schema : SuccessfulGetOperation
Type:
Show Source
object
-
message: string
The response message.Example:
Loaded 1 entries
-
success: boolean
Whether the operation was a success (true) or a failure (false).Example:
true
Nested Schema : graphGraphsRead
Type:
Show Source
object
-
Edges: array
Edges
Links in the topology graph (ConnectsLayer2, ConnectsInterface, etc)
-
Nodes: array
Nodes
Nodes in the topology graph (device, router, network interface, etc).
Nested Schema : Edges
Type:
array
Links in the topology graph (ConnectsLayer2, ConnectsInterface, etc)
Show Source
Nested Schema : Nodes
Type:
array
Nodes in the topology graph (device, router, network interface, etc).
Show Source
Nested Schema : items
Type:
Show Source
object
-
LinkKey: string
Identifier composed of the source node ID and target node ID.Example:
bbdcf488-37a1-43ea-b892-b3dde946847d,5438f283-07b5-4367-a36b-a8d3ca9b96fd
-
Properties: object
Properties
Properties for the edge. The properties will depend on the edge type and any custom properties created. The following is a default ConnectsLayer2-type edge list of properties.
-
RecordId: string
Identifier composed of edge ID, source node ID, and target node ID.Example:
4029c7f2-b63d-443c-a855-3b763a16954b_bbdcf488-37a1-43ea-b892-b3dde946847d_5438f283-07b5-4367-a36b-a8d3ca9b96fd
-
Source: string
Name of the source vertex.Example:
router.example.com
-
Target: string
Name of the target vertex.Example:
veth2e99c9f
Nested Schema : Properties
Type:
object
Properties for the edge. The properties will depend on the edge type and any custom properties created. The following is a default ConnectsLayer2-type edge list of properties.
Show Source
-
HopCount: integer
Number of hops from the starting vertexExample:
1
-
LineSize: integer
Line sizeExample:
1
-
Stroke: string
Type of edge pattern. Allowed Values: - Solid - DashedExample:
Solid
-
TimestampModified: string
Date and time the edge was created or last modifiedExample:
2023-04-18T12:34:22.000Z
-
Type: string
The edge typeExample:
HasInterface
-
TypeDirection: string
Describes the arrows on the end of the edge. Allowed Values: - Directed - an arrow on one of the edge pointing to the target - Non-Directed - an arrow on both ends of the edge pointing to the source and targetExample:
Non-Directed
Nested Schema : items
Type:
Show Source
object
-
NodeName: string
Node NameExample:
router.example.com
-
Properties: object
Properties
Properties for the node. The properties will depend on the node type and any custom properties created. The following is a default device-type node list of properties.
Nested Schema : Properties
Type:
object
Properties for the node. The properties will depend on the node type and any custom properties created. The following is a default device-type node list of properties.
Show Source
-
depth: integer
Number of hops (links) to followExample:
0
-
DeviceID: integer
Device IDExample:
349
-
Group: boolean
To check the node should be nested as part of the VertexGroupByTypeName or VertexTuckAwayTypeName selection.Example:
true
-
IPAddress: string
IP AddressExample:
100.77.220.52
-
Name: string
Name of the nodeExample:
router.example.com
-
NodeFontAwesomeIcon: string
FontAwesome icon class. Each node will only have one of the following- NodeIcon, NodeFontAwesomeIcon, and NodeUANIcon.Example:
fa fa-server-network
-
NodeIcon: string
Path to the image icon used to represent the node. Each node will only have one of the following- NodeIcon, NodeFontAwesomeIcon, and NodeUANIconExample:
fa fa-server-network
-
NodeUANIcon: string
Universal Assurance Network icon class. Each node will only have one of the following- NodeIcon, NodeFontAwesomeIcon, and NodeUANIcon.
-
TimestampModified: string
Time stamp ModifiedExample:
2023-09-03 06:00:18
-
VertexClass: string
Type of the nodeExample:
Device
-
VertexID: string
Vertex IDExample:
1c730895-8505-43a9-ac8e-f18c75edcde9
-
ZoneID: integer
Zone IDExample:
3
Default Response
Failed operation
Root Schema : schema
Type:
Show Source
object
-
errors: array
errors
The list of errors reported. Validation errors will be keyed by record field.
-
message: string
The response message.Example:
Exception thrown
-
success: boolean
Whether the operation was a success (true) or a failure (false).Example:
false
Nested Schema : errors
Type:
array
The list of errors reported. Validation errors will be keyed by record field.
Show Source
Nested Schema : items
Type:
object