GET /api/topology/groups

Description

Get all groups in the topology

The group of Node Managers is also returned.


Resource URL

https://localhost:8090/api/topology/groups


Parameters


Response Codes

Response Code Description
200 Success. The response body contains a list of groups. Refer to Javadoc for com.vordel.api.topology.model.Group.

Example Request and Response

GET https://localhost:8090/api/topology/groups

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
                }
            ]
        },
        {
            "id": "group-1",
            "name": "Node Manager Group",
            "tags": {},
            "services": [
                {
                    "id": "nodemanager-1",
                    "name": "Node Manager on host.com",
                    "type": "nodemanager",
                    "scheme": "https",
                    "hostID": "host-1",
                    "managementPort": 8090,
                    "tags": {
                        "internal_admin_nm": "true"
                    },
                    "enabled": true
                }
            ]
        }
    ]
}