Get topology data by relationships

This endpoint is used to get topology data by providing relationship information about resources.

Leave Feedback

URL

GET https://{api-url}/api/v2/tenants/{clientId}/topology/{resourceUUID}

Sample URLs

https://{api-url}/api/v2/tenants/client_4/topology/cf4172c9-96ff-47ab-bb03-9b35ddd115dd

Topology relationships provide operators and administrators with the background for troubleshooting, capacity planning, and architecture review. This API retrieves these relationships that exist across the hybrid infrastructure. Topology data can be retrieved one-level away from the resource (nearest neighbor).

Header format

HeaderValue
AuthorizationToken {accessToken}
Content-typeapplication/json
Acceptapplication/json

Status code

200 OK

Sample response

{
  "name": "Device1",
  "ipAddress": "1.1.1.1",
  "uuid": "-1525903367906475008",
  "AliasName": "aliasName",
  "HostName": "hostName",
  "ResourceName": "resourceName",
  "Connects: ": [
    {
      "name": "Device2",
      "ipAddress": "1.1.1.2",
      "uuid": "-4892213965402158210",
      "AliasName": "aliasName",
      "HostName": "hostName",
      "ResourceName": "resourceName"
    }
  ],
  "Runs On: ": [],
  "Uses: ": [
    {
      "name": "Device2",
      "ipAddress": "1.1.1.2",
      "uuid": "-4892213965402158210",
      "AliasName": "aliasName",
      "HostName": "hostName",
      "ResourceName": "resourceName"
    }
  ],
  "Network Topology: ": [
    {
      "name": "Device2",
      "ipAddress": "1.1.1.2",
      "uuid": "-4892213965402158210",
      "AliasName": "aliasName",
      "HostName": "hostName",
      "ResourceName": "resourceName"
    },
    {
      "name": "Device3",
      "ipAddress": "1.1.1.3",
      "uuid": "-5975476380313466445",
      "AliasName": "aliasName",
      "HostName": "hostName",
      "ResourceName": "resourceName"
    }
  ]
}