/topologies/{topologyName}/links/{sourceNode}/{sinkNode}

The /topologies/{topologyName}/links/{sourceNode}/{sinkNode} endpoint allows you to retrieve a link between two topology nodes.

To create, retrieve and delete one or more links in a topology see /topologies/{topologyName}/links.

To retrieve and delete all links for a topology node see /topologies/{topologyName}/links/{nodeName}.

Back to Topologies API Endpoint Reference.

GET

Retrieves link details for two specified topology nodes.

Path parameters

The GET request takes the following path parameters:

Name

Type

Required

Description

topologyName

String

Yes

Name of the topology.

sourceNode

String

Yes

Name of the source node. Note that topology links in Moogsoft Enterprise are bidirectional.

sinkNode

String

Yes

Name of the sink node. Note that topology links in Moogsoft Enterprise are bidirectional.

Response

The GET request returns the following response:

Successful requests return an array of JSON objects containing the following:

Name

Type

Description

description

String

Description of the link between the nodes.

sourceNode

String

Name of the source node. Note that topology links in Moogsoft Enterprise are bidirectional.

sinkNode

String

Name of the sink node. Note that topology links in Moogsoft Enterprise are bidirectional.

Example

The following example demonstrates making a GET request to the /topologies/{topologyName}/links/{sourceNode}/{sinkNode} endpoint.

Request example

Example cURL request for details of the link between "node1" and "node2" in the "host" topology:

curl -X GET \
https://example.com/api/v1/topologies/host/links/node1/node2 \
-u phil:password123

Response example

Example response returning the link details:

[
    {  
        "description": "link1",  
        "sourceNode": "node1",
        "sinkNode": "node2"
    }
]