Get client level topology relations

Gets topology data by providing relationship information about resources. Topology relationships provide operators and administrators with the background for troubleshooting, capacity planning, and architecture review. This API gets these relationships that exist across the resources. Topology data can be retrieved one-level away from the resource (nearest neighbour).

This API is used to get client level topology relations from a graph by clientId, entity type and entity id


  • Authorization: Bearer {accessToken}
  • Content-Type: application/json
  • Accept: application/json

Supported Fields:

Name Type Mandatory Description Default Values References
entityType String false entity type RESOURCE entityType=RESOURCE
depth Integer false depth 1 depth=2
relation String false relation EMPTY relation=NetworkTopology
queryString String false queryString EMPTY queryString=srcOperStatus:UP%2bsrcAdminStatus:UP
pageNo Integer false pageNo 1
pageSize Integer false pageSize 100

Possible Relation: manages, managed by,contains,contained in,provides,initiates,powers,post data,receive data,uses,used by,hosts,consumes,impacts,defines,runs on,hosted on,supported by,depends,consumes,registered on,impacts,deps,topology,NetworkTopology,running,connects,memberof,associatewith,ClusterOf,belongsTo,attachedto,componentOf

Example 1:

Path Parameters

  • tenantIdstringrequired

  • entityTypestringrequired

  • entityIdstringrequired


  • resultsarray

  • totalResultsinteger

  • pageNointeger

  • pageSizeinteger

  • totalPagesinteger

  • nextPageboolean

  • descendingOrderboolean

Loading Examples...