PUT /api/topology/hosts
Description
Update the name of a host.
The id cannot be updated.
Resource URL
https://localhost:8090/api/topology/hosts
Parameters
host | mandatory | The host with updated name. This is passed in the request body. The id must be set. Refer to Javadoc for com.vordel.api.topology.model.Host . |
Response Codes
Response Code | Description |
---|---|
200 | Success. The response body contains the updated host. |
400 | The response contains an error e.g. an attempt is made to update a host with invalid data. |
404 | The response contains an error indicating that the host 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/hosts
{
"id" : "host-1"
"name": "hostone.com"
}
HTTP 1.1 200 OK
{
"result": {
"id" : "host-1",
"name": "hostone.com"
}
}