/topologies/{topologyName}/nodes/{nodeName}

The /topologies/{topologyName}/nodes/{nodeName} endpoint allows you to retrieve a single existing node in a topology.

To create, retrieve, update and delete multiple topology nodes see /topologies/{topologyName}/nodes.

Back to Topologies API Endpoint Reference.

GET

Retrieves details of a specified topology node.

Path parameters

The GET request takes the following path parameters:

Name

Type

Required

Description

topologyName

String

Yes

Name of the topology.

nodeName

String

Yes

Name of the topology node.

Response

The GET request returns the following response:

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

Name

Type

Description

name

String

Name of the node.

description

String

Description of the node.

If you send a nonexistent node name in the request, the HTTP code 204 is returned with no content.

Example

The following example demonstrates making a GET request to the /topologies/{topologyName}/nodes/{nodeName} endpoint.

Request example

Example cURL request for details of the "node1" node in the "host" topology:

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

Response example

Example response returning the topology's details:

{  
    "name": "node1",  
    "description": "Primary node"
}