Params

Param name Description
host_id
optional

ID of host

Validations:

  • String

hostgroup_id
optional

ID of host group

Validations:

  • String

domain_id
optional

ID of domain

Validations:

  • String

operatingsystem_id
optional

ID of operating system

Validations:

  • String

location_id
optional

ID of location

Validations:

  • String

organization_id
optional

ID of organization

Validations:

  • String

subnet_id
optional

ID of subnet

Validations:

  • String

show_hidden
optional

Display hidden values

Validations:

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

search
optional

filter results

Validations:

  • String

order
optional

sort results

Validations:

  • String

page
optional

paginate results

Validations:

  • String

per_page
optional

number of entries per request

Validations:

  • String

Search fields

Field name Type Possible values
domain_name string
host_group_name string
host_name string
location_name string
name string
organization_name string
os_name string
subnet_name text
type string
value text