Help us improve your experience.

Let us know what you think.

Do you have time for a two-minute survey?

 
ON THIS PAGE
 

GET /config/deployment/hosts

SUMMARY Retrieves a list of all deployed hosts.

Retrieves the list of all deployed hosts.

Table 1: GET /config/deployment/hosts resource details:

GET /config/deployment/hosts resource details

MIME Type

application/json

Table 2: GET /config/deployment/hosts request parameter details:

GET /config/deployment/hosts request parameter details

Parameter Type Optionality Data Type MIME Type Description

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.

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.
Table 3: GET /config/deployment/hosts response codes:

GET /config/deployment/hosts response codes

HTTP Response Code Unique Code Description

200

The host list was successfully retrieved.

500

1001

An error occurred during the attempt to retrieve the host list.

Response Description

A list of all the hosts. Each Host object has the following fields:
  • id - The ID of this managed host.
  • hostname - The host name of this managed host.
  • private_ip - The private IP of this managed host.
  • public_ip - The public IP of this managed host.
  • appliance - An object that represents the appliance type ID and description of this managed host.
  • version - The installed version on this managed host.
  • status - The status of this managed host.
  • email_server_id - The id of the email server for this managed host.
  • eps_rate_hardware_limit - The upper limit for eps_allocation based on hardware constraints for this managed host.
  • eps_allocation - The allocated eps rate of this managed host.
  • average_eps - The average eps rate of this managed host over the previous month.
  • peak_eps - The peak eps rate that was experienced by this managed host over the previous month.
  • proxy_server_id - The id of the proxy server for this managed host.
  • fpm_rate_hardware_limit - The upper limit for fpm_allocation based on hardware constraints for this managed host
  • fpm_allocation - The allocated fpm rate of this managed host.
  • average_fpm - The average fpm rate of this managed host over the previous month.
  • peak_fpm - The peak fpm rate that was experienced by this managed host over the previous month.
  • primary_server_id - The ID for the primary server host for this managed host.
  • secondary_server_id - If configured, the ID for the secondary server host for this managed host.
  • license_serial_number - The serial number that is associated with this managed host's license.
  • components - A list of components that are associated with this managed host.
  • compression_enabled - Whether or not compression is enabled for this managed host.
  • encryption_enabled - Whether or not encryption is enabled for this managed host.
  • cpus - The number of cpus on this host.
  • total_memory - The total amount of memory in kb.
  • app_memory - The total amount of memory available to apps in kb.

Response Sample