GET /api/hosts/:id
Show a host

Examples

GET /api/hosts/host3
200
{
  "ip": null,
  "ip6": null,
  "last_report": null,
  "mac": null,
  "realm_id": null,
  "realm_name": null,
  "sp_mac": null,
  "sp_ip": null,
  "sp_name": null,
  "domain_id": null,
  "domain_name": null,
  "architecture_id": null,
  "architecture_name": null,
  "operatingsystem_id": null,
  "operatingsystem_name": null,
  "subnet_id": null,
  "subnet_name": null,
  "subnet6_id": null,
  "subnet6_name": null,
  "sp_subnet_id": null,
  "ptable_id": null,
  "ptable_name": null,
  "medium_id": null,
  "medium_name": null,
  "pxe_loader": null,
  "build": false,
  "comment": null,
  "disk": null,
  "installed_at": null,
  "model_id": null,
  "hostgroup_id": null,
  "owner_id": 135138680,
  "owner_name": "Admin User",
  "owner_type": "User",
  "enabled": true,
  "managed": false,
  "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": "host3",
  "image_id": null,
  "image_name": null,
  "created_at": "2021-09-01 10:26:17 UTC",
  "updated_at": "2021-09-01 10:26:17 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": "host3",
  "id": 3,
  "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": null,
  "hostgroup_title": null,
  "parameters": [
    {
      "priority": 70,
      "created_at": "2021-09-01 10:26:17 UTC",
      "updated_at": "2021-09-01 10:26:17 UTC",
      "id": 767575239,
      "name": "parameter1",
      "parameter_type": "string",
      "value": "parameter value 1"
    }
  ],
  "all_parameters": [
    {
      "priority": 70,
      "created_at": "2021-09-01 10:26:17 UTC",
      "updated_at": "2021-09-01 10:26:17 UTC",
      "id": 767575239,
      "name": "parameter1",
      "parameter_type": "string",
      "value": "parameter value 1"
    },
    {
      "priority": null,
      "created_at": "2021-09-01 10:26:15 UTC",
      "updated_at": "2021-09-01 10:26:15 UTC",
      "id": 513706444,
      "name": "loc_param",
      "parameter_type": "string",
      "value": "abc"
    },
    {
      "priority": null,
      "created_at": "2021-09-01 10:26:15 UTC",
      "updated_at": "2021-09-01 10:26:15 UTC",
      "id": 32400255,
      "name": "org_param",
      "parameter_type": "string",
      "value": "xyz"
    },
    {
      "priority": null,
      "created_at": "2021-09-01 10:26:15 UTC",
      "updated_at": "2021-09-01 10:26:15 UTC",
      "id": 636252244,
      "name": "test",
      "parameter_type": "string",
      "value": "myvalue"
    }
  ],
  "interfaces": [
    {
      "subnet_id": null,
      "subnet_name": null,
      "subnet6_id": null,
      "subnet6_name": null,
      "domain_id": null,
      "domain_name": null,
      "created_at": "2021-09-01 10:26:17 UTC",
      "updated_at": "2021-09-01 10:26:17 UTC",
      "managed": true,
      "identifier": null,
      "id": 3,
      "name": "host3",
      "ip": null,
      "ip6": null,
      "mac": null,
      "mtu": null,
      "fqdn": "host3",
      "primary": true,
      "provision": true,
      "type": "interface",
      "virtual": false
    }
  ],
  "permissions": {
    "view_hosts": true,
    "create_hosts": false,
    "edit_hosts": false,
    "destroy_hosts": false,
    "build_hosts": false,
    "power_hosts": false,
    "console_hosts": false,
    "ipmi_boot_hosts": false,
    "view_1": false,
    "view_2": false
  }
}

Params

Param name Description
location_id
optional

Set the current location context for the request

Validations:

  • Must be a Integer
organization_id
optional

Set the current organization context for the request

Validations:

  • Must be a Integer
id
required

Validations:

  • Must be an identifier, string from 1 to 128 characters containing only alphanumeric characters, dot(.), space, underscore(_), hypen(-) with no leading or trailing space.
show_hidden_parameters
optional

Display hidden parameter values

Validations:

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