POST
Server Groups
Mule Management Console (MMC) was deprecated in December 2015. Its End of Life is July 15, 2019. For more information see the MMC Migrator Tool or contact your Customer Success Manager to determine how you can migrate to Anypoint Runtime Manager. |
This document, as well as the rest of the documents that make up the Mule Management Console REST API Reference Guide, are a technical reference only. This document does not provide contextual information such as instructions, use cases or scenarios. To understand this document, you should be familiar with MULE ESB, Server Groups and the REST API.
Assumptions: | |
---|---|
Host |
localhost |
Port |
8080 |
Deployed app |
mmc.war |
User/Password |
admin/admin |
For a detailed description of the format used in this document, consult Content Organization and Conventions.
/api/serverGroups
CREATE |
Creates a new Server Group.
STUDIO Visual Editor
JSON
{
"name": "NewGroupName"
}
Key | Type | Summary | Child of |
---|---|---|---|
name |
String |
Name of the Server Group to be created |
— |
Using CURL on Windows
Note that this syntax is an example. Be sure to replace http://locahost:8080/mmc-console-3.7.3 with your own MMC hostname, port number, and setting for mmc-console-3.7.3 (which is usually the name of the deployed mmc .war file).
curl --basic -u admin:admin -d "{ \"name\" : \"NewGroupName\" }" --header "Content-Type: application/json" http://localhost:8080/mmc-console-3.7.3/api/serverGroups
Using CURL on Linux
curl --basic -u admin:admin -d '{ "name" : "NewGroupName" }" --header 'Content-Type: application/json' http://localhost:8080/mmc-console-3.7.3/api/serverGroups
Response
JSON
Note that this syntax is an example. Be sure to replace http://locahost:8080/mmc-console-3.7.3 with your own MMC hostname, port number, and setting for mmc-console-3.7.3 (which is usually the name of the deployed mmc .war file).
{
"name": "NewGroupName",
"id": "73d89173-290e-4cb3-a61c-e11deb74767d",
"serverCount": 0,
"href": "http://localhost:8080/mmc-console-3.7.3/api/serverGroups/73d89173-290e-4cb3-a61c-e11deb74767d"
}
Key | Type | Summary | Child of |
---|---|---|---|
name |
String |
Name of the created Server Group |
— |
id |
String |
MMC ID for the Server Group. |
— |
serverCount |
String |
Number of servers assigned to the Server Group |
— |
href |
String |
Full link to the Server Group resource on which you can perform an operation |
— |
Common Return codes
201 |
The request has been fulfilled and resulted in a new Server Group being created |
409 |
A server group with that name already exists |
500 |
Error while creating a Server Group |
MMC version
From |
3.2.2 |
GET |
LIST ALL |
Lists all available Server Groups.
STUDIO Visual Editor
Using CURL
Note that this syntax is an example. Be sure to replace http://locahost:8080/mmc-console-3.7.3 with your own MMC hostname, port number, and setting for mmc-console-3.7.3 (which is usually the name of the deployed mmc .war file).
curl --basic -u admin:admin http://localhost:8080/mmc-console-3.7.3/api/serverGroups
Response
JSON
Note that this syntax is an example. Be sure to find your own MMC hostname, port number, and setting for mmc-console-3.7.3 (which is usually the name of the mmc .war file).
{
"total": 1,
"data": [
{
"name": "NewGroupName",
"id": "73d89173-290e-4cb3-a61c-e11deb74767d",
"serverCount": 0,
"href": "http://localhost:8080/mmc-console-3.7.3/api/serverGroups/73d89173-290e-4cb3-a61c-e11deb74767d"
}
]
}
Key | Type | Summary | Child of |
---|---|---|---|
total |
Integer |
The total number of Server Groups |
— |
data |
Array |
An array of server group types |
— |
name |
String |
The identifying name of the server group |
data |
id |
String |
The server group identifier |
data |
serverCount |
Integer |
The number of servers in the server group |
data |
href |
String |
Full link to the Server Group resource to which you can perform an operation |
data |
Common Return codes
200 |
The operation was successful |
MMC version
From |
3.2.2 |
/api/serverGroups/{serverGroupId}
GET |
LIST |
Lists details for a specific Server Group.
Request
SYNTAX
Note that this syntax is an example. Be sure to replace http://locahost:8080/mmc-console-3.7.3 with your own MMC hostname, port number, and setting for mmc-console-3.7.3 (which is usually the name of the deployed mmc .war file).
GET http://localhost:8080/mmc-console-3.7.3/api/serverGroups/{serverGroupId}
Key | Type | Summary | Child of |
---|---|---|---|
serverGroupdId |
String |
ID of the server group to be listed. Invoke LIST ALL to obtain it |
— |
Using CURL
Note that this syntax is an example. Be sure to replace http://locahost:8080/mmc-console-3.7.3 with your own MMC hostname, port number, and setting for mmc-console-3.7.3 (which is usually the name of the deployed mmc .war file).
curl --basic -u admin:admin http://localhost:8080/mmc-console-3.7.3/api/serverGroups/37f6cd27-98b3-44b1-97e6-50b75e47f8c1
Response
JSON
Note that this syntax is an example. Be sure to replace http://locahost:8080/mmc-console-3.7.3 with your own MMC hostname, port number, and setting for mmc-console-3.7.3 (which is usually the name of the deployed mmc .war file).
{
"name": "NewGroupName",
"id": "73d89173-290e-4cb3-a61c-e11deb74767d",
"serverCount": 0,
"href": "http://localhost:8080/mmc-console-3.7.3/api/serverGroups/73d89173-290e-4cb3-a61c-e11deb74767d"
}
Key | Type | Summary | Child of |
---|---|---|---|
name |
String |
— |
|
id |
String |
Id of the Server Group |
— |
serverCount |
Number of servers belonging to the Server Group |
— |
|
href |
String |
Full link to the Server Group resource |
— |
Common Return codes
200 |
The operation was successful |
404 |
A server with that ID was not found |
MMC version
From |
3.2.2 |
PUT |
RENAME |
Renames a specific Server Group.
Request
JSON
Note that this syntax is an example. Be sure to replace http://locahost:8080/mmc-console-3.7.3 with your own MMC hostname, port number, and setting for mmc-console-3.7.3 (which is usually the name of the deployed mmc .war file).
{
"name": "NewGroupName",
"id": "73d89173-290e-4cb3-a61c-e11deb74767d",
"serverCount": 0,
"href": "http://localhost:8080/mmc-console-3.7.3/api/serverGroups/73d89173-290e-4cb3-a61c-e11deb74767d"
}
Key | Type | Summary | Child of | Required |
---|---|---|---|---|
name |
String |
Name of the created Server Group |
— |
Yes |
id |
String |
MMC ID of the Server Group |
— |
No |
serverCount |
String |
Number of servers assigned to the Server Group |
— |
No |
href |
String |
Full link to the Server Group resource on which you can perform an operation |
— |
No |
Note that the "name" attribute is the only required attribute. The other attributes are include to match the JSON response from an /api/ServerGroups or /api/serverGroups/{serverGroupId} GET request.
Using CURL on Windows
Note that this syntax is an example. Be sure to replace http://locahost:8080/mmc-console-3.7.3 with your own MMC hostname, port number, and setting for mmc-console-3.7.3 (which is usually the name of the mmc .war file).
curl --basic -u admin:admin -X PUT -d "{\"name\":\"NewName\",\"id\":\"330d9139-4462-4e36-b76c-569776cc3da9\",\"href\": \"http://localhost:8080/mmc-console-3.7.3/api/serverGroups/330d9139-4462-4e36-b76c-569776cc3da9\",\"serverCount\":0}" --header "Content-Type:application/json" http://localhost:8080/mmc-console-3.7.3/api/serverGroups/330d9139-4462-4e36-b76c-569776cc3da9
Using CURL on Linux
Note that this syntax is an example. Be sure to replace http://locahost:8080/mmc-console-3.7.3 with your own MMC hostname, port number, and setting for mmc-console-3.7.3 (which is usually the name of the deployed mmc .war file).
curl --basic -u admin:admin -X PUT -d '{"name":"NewName","id":"330d9139-4462-4e36-b76c-569776cc3da9","href": "http://localhost:8080/mmc-console-3.7.3/api/serverGroups/330d9139-4462-4e36-b76c-569776cc3da9","serverCount":0}' --header 'Content-Type:application/json' http://localhost:8080/mmc-console-3.7.3/api/serverGroups/330d9139-4462-4e36-b76c-569776cc3da9
Response
JSON
Note that this syntax is an example. Be sure to replace http://locahost:8080/mmc-console-3.7.3 with your own MMC hostname, port number, and setting for mmc-console-3.7.3 (which is usually the name of the deployed mmc .war file).
{
"name": "NewGroupName",
"id": "73d89173-290e-4cb3-a61c-e11deb74767d",
"serverCount": 0,
"href": "http://localhost:8080/mmc-console-3.7.3/api/serverGroups/73d89173-290e-4cb3-a61c-e11deb74767d"
}
Key | Type | Summary | Child of |
---|---|---|---|
name |
String |
Name of the created Server Group |
— |
id |
String |
MMC ID of the Server Group |
— |
serverCount |
String |
Number of servers assigned to the Server Group |
— |
href |
String |
Full link to the Server Group resource to which you can perform an operation |
— |
Common Return codes
200 |
The operation was successful |
500 |
Error while renaming a Server Group |
MMC version
From |
3.2.2 |
DELETE |
REMOVE |
Removes a specific Server Group.
Request
SYNTAX
Note that this syntax is an example. Be sure to replace http://locahost:8080/mmc-console-3.7.3 with your own MMC hostname, port number, and setting for mmc-console-3.7.3 (which is usually the name of the deployed mmc .war file).
DELETE http://localhost:8080/mmc-console-3.7.3/api/serverGroups/{serverGroupId}
Key | Type | Summary | Child of |
---|---|---|---|
serverGroupdId |
String |
ID of the server group to be removed. Invoke LIST ALL to obtain it |
— |
Using CURL
Note that this syntax is an example. Be sure to replace http://locahost:8080/mmc-console-3.7.3 with your own MMC hostname, port number, and setting for mmc-console-3.7.3 (which is usually the name of the deployed mmc .war file).
curl --basic -u admin:admin -X DELETE http://localhost:8080/mmc-console-3.7.3/api/serverGroups/37f6cd27-98b3-44b1-97e6-50b75e47f8c1
Response
JSON
200 OK
Common Return codes
200 |
The operation was successful |
MMC version
From |
3.2.2 |