Help us improve your experience.

Let us know what you think.

Do you have time for a two-minute survey?

 
ON THIS PAGE
 

GET /system/servers/{server_id}

SUMMARY Retrieves a server host based on the supplied server ID.

Table 1: GET /system/servers/{server_id} resource details:

GET /system/servers/{server_id} resource details
MIME Type

application/json

Table 2: GET /system/servers/{server_id} request parameter details:

GET /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.

fields

query

Optional

String

text/plain

Optional - Use this parameter to specify which fields you would like to get back in the response. Fields that are not named are excluded. Specify subfields in brackets and multiple fields in the same object are separated by commas.
Table 3: GET /system/servers/{server_id} response codes:

GET /system/servers/{server_id} response codes
HTTP Response Code Unique Code Description

200

The requested server record was retrieved.

404

1002

The requested server record with the given server ID cannot be found.

422

1005

One or more parameters are invalid in request.

500

1020

An error occurred while trying to retrieve the requested server host with the given Id.

Response Description

A 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 address of this server.
  • status - String - The status of this server.

Response Sample