PUT /api/topology/services/{groupID}
Description
This method may be used to update a service's name, tags, management port, or scheme.
A service is an API Server instance, or Node Manager.
The id or type cannot be updated.
Resource URL
https://localhost:8090/api/topology/services/{groupID}
Parameters
groupID | mandatory | The groupID that the service resides in. |
service | mandatory | The service to be updated. This is passed in the request body. The id must be set. Refer to Javadoc for com.vordel.api.topology.model.Service . |
Response Codes
Response Code | Description | |
---|---|---|
200 | Success. The response body contains the updated service. | |
400 | The response contains an error e.g.:-
|
', '"', ':'. |
404 | The response contains an error indicating that the service does not exist. | |
500 | The response contains an error e.g. a failure occurred when propagating this topology update to other Node Managers. |
Example Request and Response
PUT https://localhost:8090/api/topology/services/{groupID}
{
"id": "instance-1",
"name": "APIServer1",
"type": "gateway",
"scheme": "https",
"hostID": "host-1",
"managementPort": 8888,
"tags": {},
"enabled": true
}
HTTP 1.1 200 OK
{
"result": {
"id": "instance-1",
"name": "APIServer1",
"type": "gateway",
"scheme": "https",
"hostID": "host-1",
"managementPort": 8888,
"tags": {},
"enabled": true
}
}