Help us improve your experience.

Let us know what you think.

Do you have time for a two-minute survey?

 
 

GET /staged_config/deployment/hosts/{id}

Retrieves a staged host by ID. The Host object has the following fields:

Retrieves a staged host by ID.

Table 1: GET /staged_config/deployment/hosts/{id} Resource Details

MIME Type

application/json

Table 2: GET /staged_config/deployment/hosts/{id} Request Parameter Details

Parameter

Type

Optionality

Data Type

MIME Type

Description

id

path

Required

Number (Integer)

text/plain

Required - The ID of the staged host to be retrieved.

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 /staged_config/deployment/hosts/{id} Response Codes

HTTP Response Code

Unique Code

Description

200

 

The host was successfully retrieved.

404

1006

No such staged host for the given ID

422

1007

The provided id was a negative number or zero.

500

1008

An error occurred during the retrieval of the host.

Response Description

The associated staged host object.

  • 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.

Response Sample