GET /api/topology/groups/{groupID}

Description

Get a group with id of groupID from the topology.


Resource URL

https://localhost:8090/api/topology/groups/{groupID}


Parameters

groupID mandatory The id of the group to return.

Response Codes

Response Code Description
200 Success. The response body contains the group. Refer to Javadoc for com.vordel.api.topology.model.Group.
404 The response contains an error indicating that the group does not exist in the topology.

Example Request and Response

GET https://localhost:8090/api/topology/groups/group-2

HTTP 1.1 200 OK

{
    "result": {
        "id": "group-2",
        "name": "Group1",
        "tags": {},
        "services": [
            {
                "id": "instance-1",
                "name": "APIServer1",
                "type": "gateway",
                "scheme": "https",
                "hostID": "host-1",
                "managementPort": 8085,
                "tags": {},
                "enabled": true
            }
        ]
    }
}