POST /system/servers/{server_id}
Updates an existing server.
MIME Type |
---|
application/json |
Parameter | Type | Optionality | Data Type | MIME Type | Description |
---|---|---|---|---|---|
server_id |
path |
Required |
Number (Integer) |
text/plain |
Required - The id of the server. |
Parameter | Data Type | MIME Type | Description | Sample |
---|---|---|---|---|
details |
Object |
application/json |
Required - A server details record that contains the following field:
|
{ "email_server_address": "String" } |
HTTP Response Code | Unique Code | Description |
---|---|---|
200 |
The server record was updated. |
|
404 |
1002 |
The requested server record with the given server ID cannot be found. |
422 |
1005 |
One or more parameters are invalid in request. |
422 |
1006 |
Cannot connect to the mail server address on port 25. |
500 |
1020 |
An error occurred while trying to retrieve the requested server host with the given ID. |
Response Description
The updated server record that contains the following fields:
- email_server_address - String - email server address.
- hostname - String - hostname.
- managed_host_id - Number - ID of the managed host the server host belongs to.
- private_ip - String - The private IP of this server.
- status - String - The status of this server.
Response Sample
{
"email_server_address": "String",
"hostname": "String",
"managed_host_id": 42,
"private_ip": "String",
"server_id": 42,
"status": "String"
}