The /topologies/{topologyName}/links/{nodeName}
endpoint allows you to retrieve and delete all links for a topology node. Topology links in Moogsoft Onprem are bidirectional so the node name can be either a source node or a sink node.
To create, retrieve and delete one or more links in a topology see /topologies/{topologyName}/links.
Back to Topologies API Endpoint Reference.
Retrieves link details for the specified topology node.
The GET request takes the following path parameters:
Name | Type | Required | Description |
---|---|---|---|
| String | Yes | Name of the topology. |
| String | Yes | Name of the node. Note that topology links in Moogsoft Onprem are bidirectional. |
The GET request returns the following response:
Successful requests return an array of JSON objects containing the following:
Name | Type | Description |
---|---|---|
| String | Description of the link between the nodes. |
| String | Name of the source node. Note that topology links in Moogsoft Onprem are bidirectional. |
| String | Name of the sink node. Note that topology links in Moogsoft Onprem are bidirectional. |
The following example demonstrates making a GET request to the /topologies/{topologyName}/links/{nodeName}
endpoint.
Example cURL request for details of the "node2" links in the "host" topology:
curl -X GET \
https://example.com/api/v1/topologies/host/links/node2 \
-u phil:password123 \
Example response returning the links for "node2":
[
{
"description": "link1",
"sourceNode": "node2",
"sinkNode": "node1"
},
{
"description": "link2",
"sourceNode": "node2",
"sinkNode": "node3"
}
]
Deletes all links for the specified topology node.
The DELETE request takes no arguments. It deletes all links for the specified topology node.
The DELETE request returns the following response:
The following example demonstrates making a DELETE request to the /topologies/{topologyName}/links/{nodeName}
endpoint.
Example cURL request to delete all links for the "node1" node on the "host" topology:
curl -X DELETE \
https://example.com/api/v1/topologies/host/links/node1 \
-u phil:password123