POST /api/topology/groups

Description

This method adds an empty group to the topology.

No group-related files are written to the disk of any host in the domain until a new API Server instance is added to the group.

---

Resource URL

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

---

Parameters

group

mandatory

The new group to create. This is passed in the request body. The id field is not required in the request body. Refer to Javadoc for com.vordel.api.topology.model.Group.

---

Response Codes

Response Code	Description
201	Success. The response body contains the created group. The id will be set.
400	The response contains an error e.g.:- An attempt was made to create a group that already exists. An attempt was made to create a group with invalid data. An attempt is made to create a group with a number of services. Each service must be created one at a time via POST /api/topology/services/{groupID}. An attempt is made to create a group with an invalid name, illegal characters include '/', '`', '?', '*', '\', '<', '>', '	', '"', ':'.
500	The response contains an error e.g. a failure occurred when propagating this topology update to other Node Managers.

---

Example Request and Response

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

{
    "name": "Group1",
    "tags": {},
    "services": [] 
}

HTTP 1.1 201 Created

{
    "result": {
        "id" : "group-2",
        "name": "Group1",
        "tags": {},
        "services": []         
    }
}