GET /api/hosts
List all hosts

GET /api/hostgroups/:hostgroup_id/hosts
List all hosts for a host group

GET /api/locations/:location_id/hosts
List hosts per location

GET /api/organizations/:organization_id/hosts
List hosts per organization

Examples

GET /api/hosts
200
{
  "total": 1,
  "subtotal": 1,
  "page": 1,
  "per_page": 20,
  "search": "hostgroup_name = hostgroup22",
  "sort": {
    "by": null,
    "order": null
  },
  "results": [
    {
      "ip": "0.0.0.92",
      "ip6": null,
      "last_report": null,
      "mac": "00:53:67:ab:00:63",
      "realm_id": null,
      "realm_name": null,
      "sp_mac": null,
      "sp_ip": null,
      "sp_name": null,
      "domain_id": 759776765,
      "domain_name": "example319.com",
      "architecture_id": 922134523,
      "architecture_name": "x86_64-124",
      "operatingsystem_id": 1073012830,
      "operatingsystem_name": "operatingsystem118 120",
      "subnet_id": null,
      "subnet_name": null,
      "subnet6_id": null,
      "subnet6_name": null,
      "sp_subnet_id": null,
      "ptable_id": 1007981703,
      "ptable_name": "ptable115",
      "medium_id": 1011586620,
      "medium_name": "medium118",
      "pxe_loader": "Grub2 UEFI",
      "build": false,
      "comment": null,
      "disk": null,
      "installed_at": null,
      "model_id": null,
      "hostgroup_id": 928644287,
      "owner_id": 135138680,
      "owner_name": "Admin User",
      "owner_type": "User",
      "enabled": true,
      "managed": true,
      "use_image": null,
      "image_file": "",
      "uuid": null,
      "compute_resource_id": null,
      "compute_resource_name": null,
      "compute_profile_id": null,
      "compute_profile_name": null,
      "capabilities": [
        "build"
      ],
      "provision_method": "build",
      "certname": "host532.example319.com",
      "image_id": null,
      "image_name": null,
      "created_at": "2021-11-26 07:53:52 UTC",
      "updated_at": "2021-11-26 07:53:52 UTC",
      "last_compile": null,
      "global_status": 0,
      "global_status_label": "OK",
      "uptime_seconds": null,
      "bmc_available": false,
      "organization_id": 447626438,
      "organization_name": "Organization 1",
      "location_id": 255093256,
      "location_name": "Location 1",
      "puppet_status": 0,
      "model_name": null,
      "build_status": 0,
      "build_status_label": "Installed",
      "name": "host532.example319.com",
      "id": 1,
      "puppet_proxy_id": null,
      "puppet_proxy_name": null,
      "puppet_ca_proxy_id": null,
      "puppet_ca_proxy_name": null,
      "puppet_proxy": null,
      "puppet_ca_proxy": null,
      "hostgroup_name": "hostgroup22",
      "hostgroup_title": "hostgroup23/hostgroup22"
    }
  ]
}

Params

Param name Description
thin
optional

Only list ID and name of hosts

Validations:

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

ID of host group

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
include
optional

Array of extra information types to include

Validations:

  • Must be one of: parameters, all_parameters.
search
optional

filter results

Validations:

  • Must be a String
order
optional

Sort and order by a searchable field, e.g. ‘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, ‘all’ to return all results

Validations:

  • Must match regular expression /\A([1-9]\d|all)\Z$/.

Search fields

Field name Type Possible values
architecture string
boot_time datetime
build true, false
build_status built, pending, token_expired, build_failed
comment text
compute_resource string
compute_resource_id integer
created_at datetime
domain string
domain_id integer
facts string
global_status ok, warning, error
has_ip string
has_mac string
hostgroup string
hostgroup_fullname string
hostgroup_id integer
hostgroup_name string
hostgroup_title string
id integer
image string
infrastructure_facet.foreman
infrastructure_facet.smart_proxy_id
installed_at datetime
ip string
last_report datetime
location string
location_id integer
mac string
managed true, false
model string
name string
organization string
organization_id integer
origin string
os string
os_description string
os_id integer
os_major string
os_minor string
os_title string
owner string
owner_id integer
owner_type string
params string
params_name string
parent_hostgroup string
puppet_ca string
puppet_proxy_id integer
puppetmaster string
realm string
realm_id integer
reported.boot_time datetime
reported.cores integer
reported.disks_total integer
reported.ram integer
reported.sockets integer
reported.virtual true, false
smart_proxy string
status.applied integer
status.enabled true, false
status.failed integer
status.failed_restarts integer
status.interesting true, false
status.pending integer
status.restarted integer
status.skipped integer
subnet string
subnet.name text
subnet6 string
subnet6.name text
user.firstname string
user.lastname string
user.login string
user.mail string
usergroup string
usergroup.name string
uuid string