Params

Param name Description
host_id
optional

ID of host

Validations:

  • Must be a String

hostgroup_id
optional

ID of host group

Validations:

  • Must be a String

domain_id
optional

ID of domain

Validations:

  • Must be a String

operatingsystem_id
optional

ID of operating system

Validations:

  • Must be a String

location_id
optional

ID of location

Validations:

  • Must be a String

organization_id
optional

ID of organization

Validations:

  • Must be a String

subnet_id
optional

ID of subnet

Validations:

  • Must be a String

show_hidden
optional

Display hidden values

Validations:

  • Must be one of: true, false, 1, 0.

search
optional

filter results

Validations:

  • Must be a String

order
optional

Sort field and order, eg. ‘id DESC’

Validations:

  • Must be a String

page
optional

Page number, starting at 1

Validations:

  • Must be a number.

per_page
optional

Number of results per page to return

Validations:

  • Must be a number.

Search fields

Field name Type Possible values
domain_name
host_group_name
host_name
key_type
location_name
name
organization_name
os_name
parameter_type
subnet_name
type
value