GET /system/servers

Retrieves a list of all server hosts in the deployment.

Table 1. GET /system/servers resource details
MIME Type
application/json

Table 2. GET /system/servers request parameter details
Parameter	Type	Optionality	Data Type	MIME Type	Description
filter	query	Optional	String	text/plain	Optional - This parameter is used to restrict the elements in a list base on the contents of various fields.
Range	header	Optional	String	text/plain	Optional - Use this parameter to restrict the number of elements that are returned in the list to a specified range. The list is indexed starting at zero.
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 response codes
HTTP Response Code	Unique Code	Description
200		The requested list of server records was successfully retrieved.
500	1020	An error occurred while trying to retrieve the requested servers.

Response Description

A list of the servers. A server record that contains the following fields:

hostname - String - hostname.
managed_host_id - Number - ID of the managed host that the server host belongs to
private_ip - String - The private IP address of this server.
status - String - The status of this server.

Response Sample


[
    {
        "hostname": "String",
        "managed_host_id": 42,
        "private_ip": "String",
        "server_id": 42,
        "status": "String"
    }
]