Help us improve your experience.

Let us know what you think.

Do you have time for a two-minute survey?

 
 

POST /system/servers/{server_id}

Updates an existing server.

Table 1: POST /system/servers/{server_id} Resource Details

MIME Type

application/json

Table 2: POST /system/servers/{server_id} Request Parameter Details

Parameter

Type

Optionality

Data Type

MIME Type

Description

server_id

path

Required

Number (Integer)

text/plain

Required - The id of the server.

Table 3: POST /system/servers/{server_id} Request Body Details

Parameter

Data Type

MIME Type

Description

Sample

details

Object

application/json

Required - A server details record that contains the following fields:

  • email_server_address - String - email server address. This address must be a valid server address that the server can connect to through port 25.

{ "email_server_address": "String" }

Table 4: POST /system/servers/{server_id} Response Codes

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