Hosts

>>>

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/post_index
200
{
  "total": 8,
  "subtotal": 8,
  "page": 1,
  "per_page": 20,
  "search": null,
  "sort": {
    "by": null,
    "order": null
  },
  "results": [
    {
      "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": 501905019,
      "architecture_name": "x86_64",
      "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,
      "initiated_at": null,
      "installed_at": null,
      "model_id": null,
      "hostgroup_id": null,
      "owner_id": null,
      "owner_name": null,
      "owner_type": null,
      "creator_id": null,
      "creator": null,
      "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": "host1.example.com",
      "image_id": null,
      "image_name": null,
      "created_at": "2023-08-23 19:55:45 UTC",
      "updated_at": "2023-08-23 19:55:45 UTC",
      "last_compile": null,
      "global_status": 0,
      "global_status_label": "OK",
      "bmc_available": false,
      "organization_id": 114267492,
      "organization_name": "Empty Organization",
      "location_id": 255093256,
      "location_name": "Location 1",
      "puppet_status": 0,
      "model_name": null,
      "build_status": 0,
      "build_status_label": "Installed",
      "errata_status": 0,
      "errata_status_label": "All errata applied",
      "subscription_status": 0,
      "subscription_status_label": "Fully entitled",
      "purpose_sla_status": 0,
      "purpose_sla_status_label": "Unknown",
      "purpose_role_status": 0,
      "purpose_role_status_label": "Unknown",
      "purpose_usage_status": 0,
      "purpose_usage_status_label": "Unknown",
      "purpose_addons_status": 0,
      "purpose_addons_status_label": "Unknown",
      "purpose_status": 0,
      "purpose_status_label": "Unknown",
      "name": "host1.example.com",
      "id": 980190962,
      "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,
      "compute_resource_provider": null,
      "hostgroup_name": null,
      "hostgroup_title": null,
      "content_facet_attributes": {
        "id": 497076783,
        "uuid": "content_facet_one",
        "content_source_id": null,
        "content_source_name": null,
        "kickstart_repository_id": null,
        "kickstart_repository_name": null,
        "errata_counts": {
          "security": 0,
          "bugfix": 0,
          "enhancement": 0,
          "total": 0,
          "applicable": {
            "security": 1,
            "bugfix": 0,
            "enhancement": 1,
            "total": 2
          }
        },
        "applicable_deb_count": 0,
        "upgradable_deb_count": 0,
        "applicable_package_count": 0,
        "upgradable_package_count": 0,
        "applicable_module_stream_count": 0,
        "upgradable_module_stream_count": 0,
        "content_view_environments": [
          {
            "content_view": {
              "id": 30237652,
              "name": "ACME Default ContentView",
              "composite": false
            },
            "lifecycle_environment": {
              "id": 562075838,
              "name": "Library"
            }
          }
        ],
        "content_source": null,
        "kickstart_repository": null,
        "content_view": {
          "id": 30237652,
          "name": "ACME Default ContentView",
          "composite": false
        },
        "lifecycle_environment": {
          "id": 562075838,
          "name": "Library"
        }
      },
      "subscription_global_status": 0,
      "subscription_facet_attributes": {
        "id": 980190962,
        "uuid": "uuid-1",
        "last_checkin": null,
        "service_level": null,
        "release_version": null,
        "autoheal": false,
        "registered_at": "2023-08-23 19:53:08 UTC",
        "registered_through": null,
        "purpose_role": null,
        "purpose_usage": null,
        "hypervisor": false,
        "user": null,
        "purpose_addons": []
      }
    },
    {
      "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,
      "initiated_at": null,
      "installed_at": null,
      "model_id": null,
      "hostgroup_id": null,
      "owner_id": null,
      "owner_name": null,
      "owner_type": null,
      "creator_id": null,
      "creator": null,
      "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": "host2.example.com",
      "image_id": null,
      "image_name": null,
      "created_at": "2023-08-23 19:55:45 UTC",
      "updated_at": "2023-08-23 19:55:45 UTC",
      "last_compile": null,
      "global_status": 0,
      "global_status_label": "OK",
      "bmc_available": false,
      "organization_id": 114267492,
      "organization_name": "Empty Organization",
      "location_id": 255093256,
      "location_name": "Location 1",
      "puppet_status": 0,
      "model_name": null,
      "build_status": 0,
      "build_status_label": "Installed",
      "errata_status": 0,
      "errata_status_label": "All errata applied",
      "subscription_status": 0,
      "subscription_status_label": "Fully entitled",
      "purpose_sla_status": 0,
      "purpose_sla_status_label": "Unknown",
      "purpose_role_status": 0,
      "purpose_role_status_label": "Unknown",
      "purpose_usage_status": 0,
      "purpose_usage_status_label": "Unknown",
      "purpose_addons_status": 0,
      "purpose_addons_status_label": "Unknown",
      "purpose_status": 0,
      "purpose_status_label": "Unknown",
      "name": "host2.example.com",
      "id": 298486374,
      "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,
      "compute_resource_provider": null,
      "hostgroup_name": null,
      "hostgroup_title": null,
      "content_facet_attributes": {
        "id": 906413753,
        "uuid": "content_facet_two",
        "content_source_id": null,
        "content_source_name": null,
        "kickstart_repository_id": null,
        "kickstart_repository_name": null,
        "errata_counts": {
          "security": 0,
          "bugfix": 0,
          "enhancement": 0,
          "total": 0,
          "applicable": {
            "security": 1,
            "bugfix": 0,
            "enhancement": 1,
            "total": 2
          }
        },
        "applicable_deb_count": 0,
        "upgradable_deb_count": 0,
        "applicable_package_count": 0,
        "upgradable_package_count": 0,
        "applicable_module_stream_count": 0,
        "upgradable_module_stream_count": 0,
        "content_view_environments": [
          {
            "content_view": {
              "id": 909058347,
              "name": "Published Library and dev view",
              "composite": false
            },
            "lifecycle_environment": {
              "id": 292811013,
              "name": "Dev"
            }
          }
        ],
        "content_source": null,
        "kickstart_repository": null,
        "content_view": {
          "id": 909058347,
          "name": "Published Library and dev view",
          "composite": false
        },
        "lifecycle_environment": {
          "id": 292811013,
          "name": "Dev"
        }
      },
      "subscription_global_status": 0,
      "subscription_facet_attributes": {
        "id": 298486374,
        "uuid": "uuid-2",
        "last_checkin": null,
        "service_level": null,
        "release_version": null,
        "autoheal": false,
        "registered_at": "2023-08-23 19:53:08 UTC",
        "registered_through": null,
        "purpose_role": null,
        "purpose_usage": null,
        "hypervisor": false,
        "user": null,
        "purpose_addons": []
      }
    },
    {
      "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,
      "initiated_at": null,
      "installed_at": null,
      "model_id": null,
      "hostgroup_id": null,
      "owner_id": null,
      "owner_name": null,
      "owner_type": null,
      "creator_id": null,
      "creator": null,
      "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.example.com",
      "image_id": null,
      "image_name": null,
      "created_at": "2023-08-23 19:55:45 UTC",
      "updated_at": "2023-08-23 19:55:45 UTC",
      "last_compile": null,
      "global_status": 0,
      "global_status_label": "OK",
      "bmc_available": false,
      "organization_id": 114267492,
      "organization_name": "Empty Organization",
      "location_id": 255093256,
      "location_name": "Location 1",
      "puppet_status": 0,
      "model_name": null,
      "build_status": 0,
      "build_status_label": "Installed",
      "name": "host3.example.com",
      "id": 692292738,
      "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,
      "compute_resource_provider": null,
      "hostgroup_name": null,
      "hostgroup_title": null
    },
    {
      "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,
      "initiated_at": null,
      "installed_at": null,
      "model_id": null,
      "hostgroup_id": null,
      "owner_id": 135138680,
      "owner_name": "Admin User",
      "owner_type": "User",
      "creator_id": 135138680,
      "creator": "Admin 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": "host417",
      "image_id": null,
      "image_name": null,
      "created_at": "2023-08-23 20:07:41 UTC",
      "updated_at": "2023-08-23 20:07:41 UTC",
      "last_compile": null,
      "global_status": 0,
      "global_status_label": "OK",
      "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": "host417",
      "id": 980191341,
      "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,
      "compute_resource_provider": null,
      "hostgroup_name": null,
      "hostgroup_title": null
    },
    {
      "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,
      "initiated_at": null,
      "installed_at": null,
      "model_id": null,
      "hostgroup_id": null,
      "owner_id": 135138680,
      "owner_name": "Admin User",
      "owner_type": "User",
      "creator_id": 135138680,
      "creator": "Admin 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": "host418",
      "image_id": null,
      "image_name": null,
      "created_at": "2023-08-23 20:07:41 UTC",
      "updated_at": "2023-08-23 20:07:41 UTC",
      "last_compile": null,
      "global_status": 0,
      "global_status_label": "OK",
      "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",
      "subscription_status": 0,
      "subscription_status_label": "Fully entitled",
      "purpose_sla_status": 0,
      "purpose_sla_status_label": "Unknown",
      "purpose_role_status": 0,
      "purpose_role_status_label": "Unknown",
      "purpose_usage_status": 0,
      "purpose_usage_status_label": "Unknown",
      "purpose_addons_status": 0,
      "purpose_addons_status_label": "Unknown",
      "purpose_status": 0,
      "purpose_status_label": "Unknown",
      "name": "host418",
      "id": 980191342,
      "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,
      "compute_resource_provider": null,
      "hostgroup_name": null,
      "hostgroup_title": null,
      "subscription_global_status": 0,
      "subscription_facet_attributes": {
        "id": 980191275,
        "uuid": "uuid-324-206",
        "last_checkin": null,
        "service_level": null,
        "release_version": null,
        "autoheal": false,
        "registered_at": "2023-08-23 19:53:08 UTC",
        "registered_through": null,
        "purpose_role": null,
        "purpose_usage": null,
        "hypervisor": false,
        "user": null,
        "purpose_addons": []
      }
    },
    {
      "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,
      "initiated_at": null,
      "installed_at": null,
      "model_id": null,
      "hostgroup_id": null,
      "owner_id": null,
      "owner_name": null,
      "owner_type": null,
      "creator_id": null,
      "creator": null,
      "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": "host4.example.com",
      "image_id": null,
      "image_name": null,
      "created_at": "2023-08-23 19:55:45 UTC",
      "updated_at": "2023-08-23 19:55:45 UTC",
      "last_compile": null,
      "global_status": 0,
      "global_status_label": "OK",
      "bmc_available": false,
      "organization_id": 114267492,
      "organization_name": "Empty Organization",
      "location_id": 255093256,
      "location_name": "Location 1",
      "puppet_status": 0,
      "model_name": null,
      "build_status": 0,
      "build_status_label": "Installed",
      "errata_status": 0,
      "errata_status_label": "All errata applied",
      "name": "host4.example.com",
      "id": 529902380,
      "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,
      "compute_resource_provider": null,
      "hostgroup_name": null,
      "hostgroup_title": null,
      "content_facet_attributes": {
        "id": 529902380,
        "uuid": "without_errata",
        "content_source_id": null,
        "content_source_name": null,
        "kickstart_repository_id": null,
        "kickstart_repository_name": null,
        "errata_counts": {
          "security": 0,
          "bugfix": 0,
          "enhancement": 0,
          "total": 0,
          "applicable": {
            "security": 0,
            "bugfix": 0,
            "enhancement": 0,
            "total": 0
          }
        },
        "applicable_deb_count": 0,
        "upgradable_deb_count": 0,
        "applicable_package_count": 0,
        "upgradable_package_count": 0,
        "applicable_module_stream_count": 0,
        "upgradable_module_stream_count": 0,
        "content_view_environments": [
          {
            "content_view": {
              "id": 30237652,
              "name": "ACME Default ContentView",
              "composite": false
            },
            "lifecycle_environment": {
              "id": 562075838,
              "name": "Library"
            }
          }
        ],
        "content_source": null,
        "kickstart_repository": null,
        "content_view": {
          "id": 30237652,
          "name": "ACME Default ContentView",
          "composite": false
        },
        "lifecycle_environment": {
          "id": 562075838,
          "name": "Library"
        }
      }
    },
    {
      "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,
      "initiated_at": null,
      "installed_at": null,
      "model_id": null,
      "hostgroup_id": null,
      "owner_id": null,
      "owner_name": null,
      "owner_type": null,
      "creator_id": null,
      "creator": null,
      "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": "host5.example.com",
      "image_id": null,
      "image_name": null,
      "created_at": "2023-08-23 19:55:45 UTC",
      "updated_at": "2023-08-23 19:55:45 UTC",
      "last_compile": null,
      "global_status": 0,
      "global_status_label": "OK",
      "bmc_available": false,
      "organization_id": null,
      "organization_name": null,
      "location_id": null,
      "location_name": null,
      "puppet_status": 0,
      "model_name": null,
      "build_status": 0,
      "build_status_label": "Installed",
      "name": "host5.example.com",
      "id": 651939722,
      "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,
      "compute_resource_provider": null,
      "hostgroup_name": null,
      "hostgroup_title": null
    },
    {
      "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,
      "initiated_at": null,
      "installed_at": null,
      "model_id": null,
      "hostgroup_id": null,
      "owner_id": null,
      "owner_name": null,
      "owner_type": null,
      "creator_id": null,
      "creator": null,
      "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": "no-sub-facet.example.com",
      "image_id": null,
      "image_name": null,
      "created_at": "2023-08-23 19:55:45 UTC",
      "updated_at": "2023-08-23 19:55:45 UTC",
      "last_compile": null,
      "global_status": 0,
      "global_status_label": "OK",
      "bmc_available": false,
      "organization_id": 114267492,
      "organization_name": "Empty Organization",
      "location_id": 255093256,
      "location_name": "Location 1",
      "puppet_status": 0,
      "model_name": null,
      "build_status": 0,
      "build_status_label": "Installed",
      "name": "no-sub-facet.example.com",
      "id": 835059072,
      "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,
      "compute_resource_provider": null,
      "hostgroup_name": null,
      "hostgroup_title": null
    }
  ]
}

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:

  • String
location_id
optional

ID of location

Validations:

  • String
organization_id
optional

ID of organization

Validations:

  • String
include
optional

Array of extra information types to include

Validations:

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

filter results

Validations:

  • String
order
optional

Sort and order by a searchable field, e.g. '<field> DESC'

Validations:

  • 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
activation_key string
activation_key_id string
addon string
addons_status mismatched, matched, not_specified
applicable_debs string
applicable_errata string
applicable_errata_issued date
applicable_rpms string
architecture string
autoheal boolean
available_module_stream_name string
available_module_stream_stream string
boot_time
build true, false
build_status built, pending, token_expired, build_failed
comment text
compute_resource string
compute_resource_id integer
configuration_status.applied integer
configuration_status.enabled true, false
configuration_status.failed integer
configuration_status.failed_restarts integer
configuration_status.interesting true, false
configuration_status.pending integer
configuration_status.restarted integer
configuration_status.skipped integer
content_source string
content_view string
content_view_id integer
content_views string
created_at datetime
domain string
domain_id integer
errata_status security_needed, errata_needed, updated, unknown
facts string
global_status ok, warning, error
has_ip string
has_ip6 string
has_mac string
host_collection string
host_collection_id integer
hostgroup string
hostgroup_fullname string
hostgroup_id integer
hostgroup_name string
hostgroup_title string
hypervisor boolean
hypervisor_host string
id integer
image string
infrastructure_facet.foreman true, false
infrastructure_facet.smart_proxy_id
installable_errata string
installed_at datetime
installed_deb string
installed_package string
installed_package_name string
ip string
ip6 string
last_checkin datetime
last_report datetime
lifecycle_environment string
lifecycle_environment_id integer
lifecycle_environments string
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
pools_expiring_in_days string
puppet_ca string
puppet_proxy_id integer
puppetmaster string
purpose_status mismatched, matched, not_specified
pxe_loader PXELinux_BIOS, PXELinux_UEFI, Grub_UEFI, Grub2_BIOS, Grub2_ELF, Grub2_UEFI, Grub2_UEFI_SecureBoot, Grub2_UEFI_HTTP, Grub2_UEFI_HTTPS, Grub2_UEFI_HTTPS_SecureBoot, iPXE_Embedded, iPXE_UEFI_HTTP, iPXE_Chain_BIOS, iPXE_Chain_UEFI
realm string
realm_id integer
registered_at datetime
registered_through string
release_version string
reported.bios_release_date
reported.bios_vendor
reported.bios_version
reported.boot_time
reported.cores
reported.disks_total
reported.kernel_version
reported.ram
reported.sockets
reported.virtual true, false
repository string
repository_content_label string
role text
role_status mismatched, matched, not_specified
service_level string
sla_status mismatched, matched, not_specified
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
subscription_id string
subscription_name string
subscription_status valid, partial, invalid, unknown, disabled, unsubscribed_hypervisor
subscription_uuid string
trace_app string
trace_app_type string
trace_helper string
trace_status reboot_needed, process_restart_needed, updated
upgradable_debs string
upgradable_rpms string
usage text
usage_status mismatched, matched, not_specified
user.firstname string
user.lastname string
user.login string
user.mail string
usergroup string
usergroup.name string
uuid string
>>>

GET /api/hosts/:id
Show a host

Examples

GET /api/hosts/post_index
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,
  "initiated_at": null,
  "installed_at": null,
  "model_id": null,
  "hostgroup_id": null,
  "owner_id": 135138680,
  "owner_name": "Admin User",
  "owner_type": "User",
  "creator_id": 135138680,
  "creator": "Admin 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": "host418",
  "image_id": null,
  "image_name": null,
  "created_at": "2023-08-23 20:07:41 UTC",
  "updated_at": "2023-08-23 20:07:41 UTC",
  "last_compile": null,
  "global_status": 0,
  "global_status_label": "OK",
  "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",
  "subscription_status": 0,
  "subscription_status_label": "Fully entitled",
  "purpose_sla_status": 0,
  "purpose_sla_status_label": "Unknown",
  "purpose_role_status": 0,
  "purpose_role_status_label": "Unknown",
  "purpose_usage_status": 0,
  "purpose_usage_status_label": "Unknown",
  "purpose_addons_status": 0,
  "purpose_addons_status_label": "Unknown",
  "purpose_status": 0,
  "purpose_status_label": "Unknown",
  "name": "host418",
  "id": 980191342,
  "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,
  "compute_resource_provider": null,
  "hostgroup_name": null,
  "hostgroup_title": null,
  "parameters": [],
  "all_parameters": [
    {
      "priority": null,
      "created_at": "2023-08-23 19:55:45 UTC",
      "updated_at": "2023-08-23 19:55:45 UTC",
      "id": 513706444,
      "name": "loc_param",
      "parameter_type": "string",
      "associated_type": "location",
      "hidden_value?": false,
      "value": "abc"
    },
    {
      "priority": null,
      "created_at": "2023-08-23 19:55:45 UTC",
      "updated_at": "2023-08-23 19:55:45 UTC",
      "id": 32400255,
      "name": "org_param",
      "parameter_type": "string",
      "associated_type": "organization",
      "hidden_value?": false,
      "value": "xyz"
    },
    {
      "priority": null,
      "created_at": "2023-08-23 19:55:45 UTC",
      "updated_at": "2023-08-23 19:55:45 UTC",
      "id": 636252244,
      "name": "test",
      "parameter_type": "string",
      "associated_type": "global",
      "hidden_value?": false,
      "value": "myvalue"
    }
  ],
  "subscription_global_status": 0,
  "subscription_facet_attributes": {
    "host_type": null,
    "dmi_uuid": null,
    "id": 980191275,
    "uuid": "uuid-324-206",
    "last_checkin": null,
    "service_level": null,
    "release_version": null,
    "autoheal": false,
    "registered_at": "2023-08-23 19:53:08 UTC",
    "registered_through": null,
    "purpose_role": null,
    "purpose_usage": null,
    "hypervisor": false,
    "user": null,
    "purpose_addons": [],
    "virtual_host": null,
    "virtual_guests": [],
    "installed_products": [],
    "activation_keys": [],
    "compliance_reasons": []
  },
  "host_collections": [],
  "interfaces": [
    {
      "subnet_id": null,
      "subnet_name": null,
      "subnet6_id": null,
      "subnet6_name": null,
      "domain_id": null,
      "domain_name": null,
      "created_at": "2023-08-23 20:07:41 UTC",
      "updated_at": "2023-08-23 20:07:41 UTC",
      "managed": true,
      "identifier": null,
      "id": 407,
      "name": "host418",
      "ip": null,
      "ip6": null,
      "mac": null,
      "mtu": null,
      "fqdn": "host418",
      "primary": true,
      "provision": true,
      "type": "interface",
      "virtual": false
    }
  ],
  "permissions": {
    "view_hosts": true,
    "create_hosts": true,
    "edit_hosts": true,
    "destroy_hosts": true,
    "build_hosts": true,
    "power_hosts": true,
    "console_hosts": true,
    "ipmi_boot_hosts": true
  }
}

Params

Param name Description
location_id
optional

Set the current location context for the request

Validations:

  • Integer
organization_id
optional

Set the current organization context for the request

Validations:

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

POST /api/hosts
Create a host

Examples

POST /api/locations/255093256/organizations/447626438/hosts
{
  "id": null,
  "name": "host",
  "last_compile": null,
  "last_report": null,
  "updated_at": null,
  "created_at": null,
  "root_pass": "$5$8jcgIrfTz6gUHb7s$vzUeIdFv0dUjXhx4SrEdi9HNjpGeMMNN1K/TW7WQp5/",
  "architecture_id": null,
  "operatingsystem_id": null,
  "ptable_id": null,
  "medium_id": null,
  "build": false,
  "comment": null,
  "disk": null,
  "installed_at": null,
  "model_id": null,
  "hostgroup_id": null,
  "owner_id": 135138680,
  "owner_type": "User",
  "enabled": true,
  "puppet_ca_proxy_id": null,
  "managed": false,
  "use_image": null,
  "image_file": null,
  "uuid": null,
  "compute_resource_id": null,
  "puppet_proxy_id": null,
  "certname": null,
  "image_id": null,
  "type": "Host::Managed",
  "otp": null,
  "realm_id": null,
  "compute_profile_id": null,
  "provision_method": null,
  "grub_pass": null,
  "global_status": 0,
  "lookup_value_matcher": null,
  "pxe_loader": null,
  "initiated_at": null,
  "build_errors": null,
  "creator_id": 135138680,
  "subscription_facet_attributes": {
    "purpose_addons": [
      "Addon",
      "Test Addon"
    ]
  },
  "host": {
    "subscription_facet_attributes": {
      "purpose_addons": [
        "Addon",
        "Test Addon"
      ]
    },
    "build": false,
    "certname": null,
    "disk": null,
    "global_status": 0,
    "installed_at": null,
    "last_report": null,
    "otp": null,
    "provision_method": null,
    "uuid": null,
    "compute_profile_id": null,
    "compute_resource_id": null,
    "owner_id": 135138680,
    "owner_type": "User",
    "comment": null,
    "enabled": true,
    "last_compile": null,
    "managed": false,
    "name": "host",
    "root_pass": "$5$8jcgIrfTz6gUHb7s$vzUeIdFv0dUjXhx4SrEdi9HNjpGeMMNN1K/TW7WQp5/",
    "type": "Host::Managed",
    "pxe_loader": null,
    "architecture_id": null,
    "hostgroup_id": null,
    "medium_id": null,
    "model_id": null,
    "operatingsystem_id": null,
    "ptable_id": null,
    "realm_id": null,
    "grub_pass": null,
    "image_id": null,
    "image_file": null,
    "lookup_value_matcher": null,
    "use_image": null,
    "puppet_proxy_id": null,
    "puppet_ca_proxy_id": null
  }
}
201
{
  "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,
  "initiated_at": null,
  "installed_at": null,
  "model_id": null,
  "hostgroup_id": null,
  "owner_id": 135138680,
  "owner_name": "Admin User",
  "owner_type": "User",
  "creator_id": 135138680,
  "creator": "Admin 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": "host",
  "image_id": null,
  "image_name": null,
  "created_at": "2023-08-23 20:07:42 UTC",
  "updated_at": "2023-08-23 20:07:42 UTC",
  "last_compile": null,
  "global_status": 0,
  "global_status_label": "OK",
  "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": "host",
  "id": 980191348,
  "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,
  "compute_resource_provider": null,
  "hostgroup_name": null,
  "hostgroup_title": null,
  "parameters": [],
  "all_parameters": [
    {
      "priority": null,
      "created_at": "2023-08-23 19:55:45 UTC",
      "updated_at": "2023-08-23 19:55:45 UTC",
      "id": 513706444,
      "name": "loc_param",
      "parameter_type": "string",
      "associated_type": "location",
      "hidden_value?": false,
      "value": "abc"
    },
    {
      "priority": null,
      "created_at": "2023-08-23 19:55:45 UTC",
      "updated_at": "2023-08-23 19:55:45 UTC",
      "id": 32400255,
      "name": "org_param",
      "parameter_type": "string",
      "associated_type": "organization",
      "hidden_value?": false,
      "value": "xyz"
    },
    {
      "priority": null,
      "created_at": "2023-08-23 19:55:45 UTC",
      "updated_at": "2023-08-23 19:55:45 UTC",
      "id": 636252244,
      "name": "test",
      "parameter_type": "string",
      "associated_type": "global",
      "hidden_value?": false,
      "value": "myvalue"
    }
  ],
  "subscription_facet_attributes": {
    "host_type": null,
    "dmi_uuid": null,
    "id": 980191278,
    "uuid": null,
    "last_checkin": null,
    "service_level": null,
    "release_version": null,
    "autoheal": false,
    "registered_at": "2023-08-23 19:53:08 UTC",
    "registered_through": null,
    "purpose_role": null,
    "purpose_usage": null,
    "hypervisor": false,
    "user": null,
    "purpose_addons": [
      "Addon",
      "Test Addon"
    ],
    "virtual_host": null,
    "virtual_guests": [],
    "installed_products": [],
    "activation_keys": [],
    "compliance_reasons": []
  },
  "host_collections": [],
  "interfaces": [
    {
      "subnet_id": null,
      "subnet_name": null,
      "subnet6_id": null,
      "subnet6_name": null,
      "domain_id": null,
      "domain_name": null,
      "created_at": "2023-08-23 20:07:42 UTC",
      "updated_at": "2023-08-23 20:07:42 UTC",
      "managed": true,
      "identifier": null,
      "id": 413,
      "name": "host",
      "ip": null,
      "ip6": null,
      "mac": null,
      "mtu": null,
      "fqdn": "host",
      "primary": true,
      "provision": true,
      "type": "interface",
      "virtual": false
    }
  ],
  "permissions": {
    "view_hosts": true,
    "create_hosts": true,
    "edit_hosts": true,
    "destroy_hosts": true,
    "build_hosts": true,
    "power_hosts": true,
    "console_hosts": true,
    "ipmi_boot_hosts": true
  }
}

Params

Param name Description
location_id
optional

Set the current location context for the request

Validations:

  • Integer
organization_id
optional

Set the current organization context for the request

Validations:

  • Integer
host
required

Validations:

  • Hash
host[name]
required

Validations:

  • String
host[location_id]
required

Validations:

  • Must be a number.
host[organization_id]
required

Validations:

  • Must be a number.
host[ip]
optional , nil allowed

not required if using a subnet with DHCP proxy

Validations:

  • String
host[mac]
optional , nil allowed

required for managed host that is bare metal, not required if it's a virtual machine

Validations:

  • String
host[architecture_id]
optional , nil allowed

required if host is managed and value is not inherited from host group

Validations:

  • Must be a number.
host[domain_id]
optional , nil allowed

required if host is managed and value is not inherited from host group

Validations:

  • Must be a number.
host[realm_id]
optional , nil allowed

Validations:

  • Must be a number.
host[puppet_proxy_id]
optional , nil allowed

Puppet proxy ID

Validations:

  • Must be a number.
host[puppet_ca_proxy_id]
optional , nil allowed

Puppet CA proxy ID

Validations:

  • Must be a number.
host[operatingsystem_id]
optional , nil allowed

required if host is managed and value is not inherited from host group

Validations:

  • Must be a number.
host[medium_id]
optional , nil allowed

required if not imaged based provisioning and host is managed and value is not inherited from host group

Validations:

  • String
host[pxe_loader]
optional , nil allowed

DHCP filename option (Grub2/PXELinux by default)

Validations:

  • Must be one of: None, PXELinux BIOS, PXELinux UEFI, Grub UEFI, Grub2 BIOS, Grub2 ELF, Grub2 UEFI, Grub2 UEFI SecureBoot, Grub2 UEFI HTTP, Grub2 UEFI HTTPS, Grub2 UEFI HTTPS SecureBoot, iPXE Embedded, iPXE UEFI HTTP, iPXE Chain BIOS, iPXE Chain UEFI.
host[ptable_id]
optional , nil allowed

required if host is managed and custom partition has not been defined

Validations:

  • Must be a number.
host[subnet_id]
optional , nil allowed

required if host is managed and value is not inherited from host group

Validations:

  • Must be a number.
host[compute_resource_id]
optional , nil allowed

nil means host is bare metal

Validations:

  • Must be a number.
host[root_pass]
optional , nil allowed

required if host is managed and value is not inherited from host group or default password in settings

Validations:

  • String
host[model_id]
optional , nil allowed

Validations:

  • Must be a number.
host[hostgroup_id]
optional , nil allowed

Validations:

  • Must be a number.
host[owner_id]
optional , nil allowed

Validations:

  • Must be a number.
host[owner_type]
optional , nil allowed

Host's owner type

Validations:

  • Must be one of: User, Usergroup.
host[image_id]
optional , nil allowed

Validations:

  • Must be a number.
host[host_parameters_attributes]
optional , nil allowed

Host's parameters (array or indexed hash)

Validations:

  • Must be an Array of nested elements
host[host_parameters_attributes][name]
required

Name of the parameter

Validations:

  • String
host[host_parameters_attributes][value]
required

Parameter value

Validations:

  • String
host[host_parameters_attributes][parameter_type]
optional , nil allowed

Type of value

Validations:

  • Must be one of: string, boolean, integer, real, array, hash, yaml, json.
host[host_parameters_attributes][hidden_value]
optional , nil allowed

Validations:

  • Must be one of: true, false, 1, 0.
host[build]
optional , nil allowed

Validations:

  • Must be one of: true, false, 1, 0.
host[enabled]
optional , nil allowed

Include this host within Foreman reporting

Validations:

  • Must be one of: true, false, 1, 0.
host[provision_method]
optional , nil allowed

The method used to provision the host.

Validations:

  • Must be one of: build, image.
host[managed]
optional , nil allowed

True/False flag whether a host is managed or unmanaged. Note: this value also determines whether several parameters are required or not

Validations:

  • Must be one of: true, false, 1, 0.
host[progress_report_id]
optional , nil allowed

UUID to track orchestration tasks status, GET /api/orchestration/:UUID/tasks

Validations:

  • String
host[comment]
optional , nil allowed

Additional information about this host

Validations:

  • String
host[capabilities]
optional , nil allowed

Validations:

  • String
host[compute_profile_id]
optional , nil allowed

Validations:

  • Must be a number.
host[interfaces_attributes]
optional , nil allowed

Host's network interfaces.

Validations:

  • Must be an Array of nested elements
host[interfaces_attributes][id]
optional , nil allowed

ID of interface

Validations:

  • Must be a number.
host[interfaces_attributes][mac]
optional , nil allowed

MAC address of interface. Required for managed interfaces on bare metal.

Validations:

  • String
host[interfaces_attributes][ip]
optional , nil allowed

IPv4 address of interface

Validations:

  • String
host[interfaces_attributes][ip6]
optional , nil allowed

IPv6 address of interface

Validations:

  • String
host[interfaces_attributes][type]
optional , nil allowed

Interface type, e.g. bmc. Default is interface

Validations:

  • Must be one of: interface, bmc, bond, bridge.
host[interfaces_attributes][name]
optional , nil allowed

Interface's DNS name

Validations:

  • String
host[interfaces_attributes][subnet_id]
optional , nil allowed

Foreman subnet ID of IPv4 interface

Validations:

  • Must be a number.
host[interfaces_attributes][subnet6_id]
optional , nil allowed

Foreman subnet ID of IPv6 interface

Validations:

  • Must be a number.
host[interfaces_attributes][domain_id]
optional , nil allowed

Foreman domain ID of interface. Required for primary interfaces on managed hosts.

Validations:

  • Must be a number.
host[interfaces_attributes][identifier]
optional , nil allowed

Device identifier, e.g. eth0 or eth1.1

Validations:

  • String
host[interfaces_attributes][managed]
optional , nil allowed

Should this interface be managed via DHCP and DNS smart proxy and should it be configured during provisioning?

Validations:

  • Must be one of: true, false, 1, 0.
host[interfaces_attributes][primary]
optional , nil allowed

Should this interface be used for constructing the FQDN of the host? Each managed hosts needs to have one primary interface.

Validations:

  • Must be one of: true, false, 1, 0.
host[interfaces_attributes][provision]
optional , nil allowed

Should this interface be used for TFTP of PXELinux (or SSH for image-based hosts)? Each managed hosts needs to have one provision interface.

Validations:

  • Must be one of: true, false, 1, 0.
host[interfaces_attributes][username]
optional , nil allowed

Only for BMC interfaces.

Validations:

  • String
host[interfaces_attributes][password]
optional , nil allowed

Only for BMC interfaces.

Validations:

  • String
host[interfaces_attributes][provider]
optional , nil allowed

Interface provider, e.g. IPMI. Only for BMC interfaces.

Validations:

  • Must be one of: IPMI, Redfish, SSH.
host[interfaces_attributes][virtual]
optional , nil allowed

Alias or VLAN device

Validations:

  • Must be one of: true, false, 1, 0.
host[interfaces_attributes][tag]
optional , nil allowed

VLAN tag, this attribute has precedence over the subnet VLAN ID. Only for virtual interfaces.

Validations:

  • String
host[interfaces_attributes][mtu]
optional , nil allowed

MTU, this attribute has precedence over the subnet MTU.

Validations:

  • Integer
host[interfaces_attributes][attached_to]
optional , nil allowed

Identifier of the interface to which this interface belongs, e.g. eth1. Only for virtual interfaces.

Validations:

  • String
host[interfaces_attributes][mode]
optional , nil allowed

Bond mode of the interface, e.g. balance-rr. Only for bond interfaces.

Validations:

  • Must be one of: balance-rr, active-backup, balance-xor, broadcast, 802.3ad, balance-tlb, balance-alb.
host[interfaces_attributes][attached_devices]
optional , nil allowed

Identifiers of attached interfaces, e.g. `['eth1', 'eth2']`. For bond interfaces those are the slaves. Only for bond and bridges interfaces.

Validations:

  • Must be an array of any type
host[interfaces_attributes][bond_options]
optional , nil allowed

Space separated options, e.g. miimon=100. Only for bond interfaces.

Validations:

  • String
host[interfaces_attributes][compute_attributes]
optional , nil allowed

Additional compute resource specific attributes for the interface.

Validations:

  • Hash
host[compute_attributes]
optional , nil allowed

Additional compute resource specific attributes.

Validations:

  • Hash
host[content_facet_attributes]
optional , nil allowed

Parameters for host's content_facet facet

Validations:

  • Hash
host[content_facet_attributes][content_view_id]
optional , nil allowed

Validations:

  • Integer
host[content_facet_attributes][lifecycle_environment_id]
optional , nil allowed

Validations:

  • Integer
host[content_facet_attributes][content_source_id]
optional , nil allowed

Validations:

  • Integer
host[content_facet_attributes][kickstart_repository_id]
optional , nil allowed

Repository Id associated with the kickstart repo used for provisioning

Validations:

  • Integer
host[subscription_facet_attributes]
optional , nil allowed

Parameters for host's subscription_facet facet

Validations:

  • Hash
host[subscription_facet_attributes][release_version]
optional , nil allowed

Release version for this Host to use (7Server, 7.1, etc)

Validations:

  • String
host[subscription_facet_attributes][autoheal]
optional , nil allowed

Sets whether the Host will autoheal subscriptions upon checkin

Validations:

  • Must be one of: true, false, 1, 0.
host[subscription_facet_attributes][purpose_usage]
optional , nil allowed

Sets the system purpose usage

Validations:

  • String
host[subscription_facet_attributes][purpose_role]
optional , nil allowed

Sets the system purpose usage

Validations:

  • String
host[subscription_facet_attributes][purpose_addons]
optional , nil allowed

Sets the system add-ons

Validations:

  • Must be an array of any type
host[subscription_facet_attributes][service_level]
optional , nil allowed

Service level to be used for autoheal

Validations:

  • String
host[subscription_facet_attributes][hypervisor_guest_uuids]
optional , nil allowed

List of hypervisor guest uuids

Validations:

  • Must be an array of any type
host[subscription_facet_attributes][installed_products_attributes]
optional , nil allowed

List of products installed on the host

Validations:

  • Must be an Array of nested elements
host[subscription_facet_attributes][installed_products_attributes][product_id]
optional , nil allowed

Product id as listed from a host's installed products, this is not the same product id as the products api returns

Validations:

  • String
host[subscription_facet_attributes][installed_products_attributes][product_name]
optional , nil allowed

Product name as listed from a host's installed products

Validations:

  • String
host[subscription_facet_attributes][installed_products_attributes][arch]
optional , nil allowed

Product architecture

Validations:

  • String
host[subscription_facet_attributes][installed_products_attributes][version]
optional , nil allowed

Product version

Validations:

  • String
host[overwrite]
optional

Overwrite existing host (true by default)

Validations:

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

PUT /api/hosts/:id
Update a host

Examples

PUT /api/hosts/980191338
{
  "content_facet_attributes": {
    "content_view_id": 615884193,
    "lifecycle_environment_id": 292811013
  },
  "host": {
    "content_facet_attributes": {
      "content_view_id": 615884193,
      "lifecycle_environment_id": 292811013
    }
  }
}
500
{
  "error": {
    "message": "\n\n================================================================================\nAn HTTP request has been made that VCR does not know how to handle:\n  PUT https://localhost:23443/candlepin/consumers/uuid-322-458\n\nThere is currently no cassette in use. There are a few ways\nyou can configure VCR to handle this request:\n\n  * If you're surprised VCR is raising this error\n    and want insight about how VCR attempted to handle the request,\n    you can use the debug_logger configuration option to log more details [1].\n  * If you want VCR to record this request and play it back during future test\n    runs, you should wrap your test (or this portion of your test) in a\n    `VCR.use_cassette` block [2].\n  * If you only want VCR to handle requests made while a cassette is in use,\n    configure `allow_http_connections_when_no_cassette = true`. VCR will\n    ignore this request since it is made when there is no cassette [3].\n  * If you want VCR to ignore this request (and others like it), you can\n    set an `ignore_request` callback [4].\n\n[1] https://www.relishapp.com/vcr/vcr/v/3-0-3/docs/configuration/debug-logging\n[2] https://www.relishapp.com/vcr/vcr/v/3-0-3/docs/getting-started\n[3] https://www.relishapp.com/vcr/vcr/v/3-0-3/docs/configuration/allow-http-connections-when-no-cassette\n[4] https://www.relishapp.com/vcr/vcr/v/3-0-3/docs/configuration/ignore-request\n================================================================================\n\n"
  }
}

Params

Param name Description
location_id
optional

Set the current location context for the request

Validations:

  • Integer
organization_id
optional

Set the current organization context for the request

Validations:

  • Integer
id
required

Validations:

  • string from 2 to 128 characters containing only alphanumeric characters, space, '_', '-' with no leading or trailing space..
host
required

Validations:

  • Hash
host[name]
optional

Validations:

  • String
host[location_id]
optional

Validations:

  • Must be a number.
host[organization_id]
optional

Validations:

  • Must be a number.
host[ip]
optional , nil allowed

not required if using a subnet with DHCP proxy

Validations:

  • String
host[mac]
optional , nil allowed

required for managed host that is bare metal, not required if it's a virtual machine

Validations:

  • String
host[architecture_id]
optional , nil allowed

required if host is managed and value is not inherited from host group

Validations:

  • Must be a number.
host[domain_id]
optional , nil allowed

required if host is managed and value is not inherited from host group

Validations:

  • Must be a number.
host[realm_id]
optional , nil allowed

Validations:

  • Must be a number.
host[puppet_proxy_id]
optional , nil allowed

Puppet proxy ID

Validations:

  • Must be a number.
host[puppet_ca_proxy_id]
optional , nil allowed

Puppet CA proxy ID

Validations:

  • Must be a number.
host[operatingsystem_id]
optional , nil allowed

required if host is managed and value is not inherited from host group

Validations:

  • Must be a number.
host[medium_id]
optional , nil allowed

required if not imaged based provisioning and host is managed and value is not inherited from host group

Validations:

  • String
host[pxe_loader]
optional , nil allowed

DHCP filename option (Grub2/PXELinux by default)

Validations:

  • Must be one of: None, PXELinux BIOS, PXELinux UEFI, Grub UEFI, Grub2 BIOS, Grub2 ELF, Grub2 UEFI, Grub2 UEFI SecureBoot, Grub2 UEFI HTTP, Grub2 UEFI HTTPS, Grub2 UEFI HTTPS SecureBoot, iPXE Embedded, iPXE UEFI HTTP, iPXE Chain BIOS, iPXE Chain UEFI.
host[ptable_id]
optional , nil allowed

required if host is managed and custom partition has not been defined

Validations:

  • Must be a number.
host[subnet_id]
optional , nil allowed

required if host is managed and value is not inherited from host group

Validations:

  • Must be a number.
host[compute_resource_id]
optional , nil allowed

nil means host is bare metal

Validations:

  • Must be a number.
host[root_pass]
optional , nil allowed

required if host is managed and value is not inherited from host group or default password in settings

Validations:

  • String
host[model_id]
optional , nil allowed

Validations:

  • Must be a number.
host[hostgroup_id]
optional , nil allowed

Validations:

  • Must be a number.
host[owner_id]
optional , nil allowed

Validations:

  • Must be a number.
host[owner_type]
optional , nil allowed

Host's owner type

Validations:

  • Must be one of: User, Usergroup.
host[image_id]
optional , nil allowed

Validations:

  • Must be a number.
host[host_parameters_attributes]
optional , nil allowed

Host's parameters (array or indexed hash)

Validations:

  • Must be an Array of nested elements
host[host_parameters_attributes][name]
optional

Name of the parameter

Validations:

  • String
host[host_parameters_attributes][value]
optional

Parameter value

Validations:

  • String
host[host_parameters_attributes][parameter_type]
optional , nil allowed

Type of value

Validations:

  • Must be one of: string, boolean, integer, real, array, hash, yaml, json.
host[host_parameters_attributes][hidden_value]
optional , nil allowed

Validations:

  • Must be one of: true, false, 1, 0.
host[build]
optional , nil allowed

Validations:

  • Must be one of: true, false, 1, 0.
host[enabled]
optional , nil allowed

Include this host within Foreman reporting

Validations:

  • Must be one of: true, false, 1, 0.
host[provision_method]
optional , nil allowed

The method used to provision the host.

Validations:

  • Must be one of: build, image.
host[managed]
optional , nil allowed

True/False flag whether a host is managed or unmanaged. Note: this value also determines whether several parameters are required or not

Validations:

  • Must be one of: true, false, 1, 0.
host[progress_report_id]
optional , nil allowed

UUID to track orchestration tasks status, GET /api/orchestration/:UUID/tasks

Validations:

  • String
host[comment]
optional , nil allowed

Additional information about this host

Validations:

  • String
host[capabilities]
optional , nil allowed

Validations:

  • String
host[compute_profile_id]
optional , nil allowed

Validations:

  • Must be a number.
host[interfaces_attributes]
optional , nil allowed

Host's network interfaces.

Validations:

  • Must be an Array of nested elements
host[interfaces_attributes][id]
optional , nil allowed

ID of interface

Validations:

  • Must be a number.
host[interfaces_attributes][mac]
optional , nil allowed

MAC address of interface. Required for managed interfaces on bare metal.

Validations:

  • String
host[interfaces_attributes][ip]
optional , nil allowed

IPv4 address of interface

Validations:

  • String
host[interfaces_attributes][ip6]
optional , nil allowed

IPv6 address of interface

Validations:

  • String
host[interfaces_attributes][type]
optional , nil allowed

Interface type, e.g. bmc. Default is interface

Validations:

  • Must be one of: interface, bmc, bond, bridge.
host[interfaces_attributes][name]
optional , nil allowed

Interface's DNS name

Validations:

  • String
host[interfaces_attributes][subnet_id]
optional , nil allowed

Foreman subnet ID of IPv4 interface

Validations:

  • Must be a number.
host[interfaces_attributes][subnet6_id]
optional , nil allowed

Foreman subnet ID of IPv6 interface

Validations:

  • Must be a number.
host[interfaces_attributes][domain_id]
optional , nil allowed

Foreman domain ID of interface. Required for primary interfaces on managed hosts.

Validations:

  • Must be a number.
host[interfaces_attributes][identifier]
optional , nil allowed

Device identifier, e.g. eth0 or eth1.1

Validations:

  • String
host[interfaces_attributes][managed]
optional , nil allowed

Should this interface be managed via DHCP and DNS smart proxy and should it be configured during provisioning?

Validations:

  • Must be one of: true, false, 1, 0.
host[interfaces_attributes][primary]
optional , nil allowed

Should this interface be used for constructing the FQDN of the host? Each managed hosts needs to have one primary interface.

Validations:

  • Must be one of: true, false, 1, 0.
host[interfaces_attributes][provision]
optional , nil allowed

Should this interface be used for TFTP of PXELinux (or SSH for image-based hosts)? Each managed hosts needs to have one provision interface.

Validations:

  • Must be one of: true, false, 1, 0.
host[interfaces_attributes][username]
optional , nil allowed

Only for BMC interfaces.

Validations:

  • String
host[interfaces_attributes][password]
optional , nil allowed

Only for BMC interfaces.

Validations:

  • String
host[interfaces_attributes][provider]
optional , nil allowed

Interface provider, e.g. IPMI. Only for BMC interfaces.

Validations:

  • Must be one of: IPMI, Redfish, SSH.
host[interfaces_attributes][virtual]
optional , nil allowed

Alias or VLAN device

Validations:

  • Must be one of: true, false, 1, 0.
host[interfaces_attributes][tag]
optional , nil allowed

VLAN tag, this attribute has precedence over the subnet VLAN ID. Only for virtual interfaces.

Validations:

  • String
host[interfaces_attributes][mtu]
optional , nil allowed

MTU, this attribute has precedence over the subnet MTU.

Validations:

  • Integer
host[interfaces_attributes][attached_to]
optional , nil allowed

Identifier of the interface to which this interface belongs, e.g. eth1. Only for virtual interfaces.

Validations:

  • String
host[interfaces_attributes][mode]
optional , nil allowed

Bond mode of the interface, e.g. balance-rr. Only for bond interfaces.

Validations:

  • Must be one of: balance-rr, active-backup, balance-xor, broadcast, 802.3ad, balance-tlb, balance-alb.
host[interfaces_attributes][attached_devices]
optional , nil allowed

Identifiers of attached interfaces, e.g. `['eth1', 'eth2']`. For bond interfaces those are the slaves. Only for bond and bridges interfaces.

Validations:

  • Must be an array of any type
host[interfaces_attributes][bond_options]
optional , nil allowed

Space separated options, e.g. miimon=100. Only for bond interfaces.

Validations:

  • String
host[interfaces_attributes][compute_attributes]
optional , nil allowed

Additional compute resource specific attributes for the interface.

Validations:

  • Hash
host[compute_attributes]
optional , nil allowed

Additional compute resource specific attributes.

Validations:

  • Hash
host[content_facet_attributes]
optional , nil allowed

Parameters for host's content_facet facet

Validations:

  • Hash
host[content_facet_attributes][content_view_id]
optional , nil allowed

Validations:

  • Integer
host[content_facet_attributes][lifecycle_environment_id]
optional , nil allowed

Validations:

  • Integer
host[content_facet_attributes][content_source_id]
optional , nil allowed

Validations:

  • Integer
host[content_facet_attributes][kickstart_repository_id]
optional , nil allowed

Repository Id associated with the kickstart repo used for provisioning

Validations:

  • Integer
host[subscription_facet_attributes]
optional , nil allowed

Parameters for host's subscription_facet facet

Validations:

  • Hash
host[subscription_facet_attributes][release_version]
optional , nil allowed

Release version for this Host to use (7Server, 7.1, etc)

Validations:

  • String
host[subscription_facet_attributes][autoheal]
optional , nil allowed

Sets whether the Host will autoheal subscriptions upon checkin

Validations:

  • Must be one of: true, false, 1, 0.
host[subscription_facet_attributes][purpose_usage]
optional , nil allowed

Sets the system purpose usage

Validations:

  • String
host[subscription_facet_attributes][purpose_role]
optional , nil allowed

Sets the system purpose usage

Validations:

  • String
host[subscription_facet_attributes][purpose_addons]
optional , nil allowed

Sets the system add-ons

Validations:

  • Must be an array of any type
host[subscription_facet_attributes][service_level]
optional , nil allowed

Service level to be used for autoheal

Validations:

  • String
host[subscription_facet_attributes][hypervisor_guest_uuids]
optional , nil allowed

List of hypervisor guest uuids

Validations:

  • Must be an array of any type
host[subscription_facet_attributes][installed_products_attributes]
optional , nil allowed

List of products installed on the host

Validations:

  • Must be an Array of nested elements
host[subscription_facet_attributes][installed_products_attributes][product_id]
optional , nil allowed

Product id as listed from a host's installed products, this is not the same product id as the products api returns

Validations:

  • String
host[subscription_facet_attributes][installed_products_attributes][product_name]
optional , nil allowed

Product name as listed from a host's installed products

Validations:

  • String
host[subscription_facet_attributes][installed_products_attributes][arch]
optional , nil allowed

Product architecture

Validations:

  • String
host[subscription_facet_attributes][installed_products_attributes][version]
optional , nil allowed

Product version

Validations:

  • String
>>>

DELETE /api/hosts/:id
Delete a host

Params

Param name Description
location_id
optional

Set the current location context for the request

Validations:

  • Integer
organization_id
optional

Set the current organization context for the request

Validations:

  • Integer
id
required

Validations:

  • string from 2 to 128 characters containing only alphanumeric characters, space, '_', '-' with no leading or trailing space..
>>>

GET /api/hosts/:id/enc
Get ENC values of host

Params

Param name Description
location_id
optional

Set the current location context for the request

Validations:

  • Integer
organization_id
optional

Set the current organization context for the request

Validations:

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

GET /api/hosts/:id/status/:type
Get status of host

Returns string representing a host status of a given type

Params

Param name Description
location_id
optional

Set the current location context for the request

Validations:

  • Integer
organization_id
optional

Set the current organization context for the request

Validations:

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

status type, can be one of

  • global

  • configuration

  • build

Validations:

  • Must be one of: HostStatus::Global, configuration, build.
>>>

DELETE /api/hosts/:id/status/:type
Clear sub-status of host

Clears a host sub-status of a given type

Params

Param name Description
location_id
optional

Set the current location context for the request

Validations:

  • Integer
organization_id
optional

Set the current organization context for the request

Validations:

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

status type

Validations:

  • Must be one of: configuration, build.
>>>

GET /api/hosts/:id/vm_compute_attributes
Get vm attributes of host

Return the host's compute attributes that can be used to create a clone of this VM

Params

Param name Description
location_id
optional

Set the current location context for the request

Validations:

  • Integer
organization_id
optional

Set the current organization context for the request

Validations:

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

PUT /api/hosts/:id/disassociate
Disassociate the host from a VM

Params

Param name Description
location_id
optional

Set the current location context for the request

Validations:

  • Integer
organization_id
optional

Set the current organization context for the request

Validations:

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

PUT /api/hosts/:id/power
Run a power operation on host

Params

Param name Description
location_id
optional

Set the current location context for the request

Validations:

  • Integer
organization_id
optional

Set the current organization context for the request

Validations:

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

power action, valid actions are (on/start), (off/stop), (soft/reboot), (cycle/reset), (state/status)

Validations:

  • String
>>>

GET /api/hosts/:id/power
Fetch the status of whether the host is powered on or not. Supported hosts are VMs and physical hosts with BMCs.

Params

Param name Description
location_id
optional

Set the current location context for the request

Validations:

  • Integer
organization_id
optional

Set the current organization context for the request

Validations:

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

Timeout to retrieve the power status of the host in seconds. Default is 3 seconds.

Validations:

  • String
>>>

PUT /api/hosts/:id/boot
Boot host from specified device

Params

Param name Description
location_id
optional

Set the current location context for the request

Validations:

  • Integer
organization_id
optional

Set the current organization context for the request

Validations:

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

boot device, valid devices are disk, cdrom, pxe, bios

Validations:

  • String
>>>

POST /api/hosts/facts
Upload facts for a host, creating the host if required

Params

Param name Description
location_id
optional

Set the current location context for the request

Validations:

  • Integer
organization_id
optional

Set the current organization context for the request

Validations:

  • Integer
name
required

hostname of the host

Validations:

  • String
facts
required

hash containing the facts for the host

Validations:

  • Hash
certname
optional

optional: certname of the host

Validations:

  • String
type
optional

optional: the STI type of host to create

Validations:

  • String
>>>

PUT /api/hosts/:id/rebuild_config
Rebuild orchestration config

Params

Param name Description
location_id
optional

Set the current location context for the request

Validations:

  • Integer
organization_id
optional

Set the current organization context for the request

Validations:

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

Limit rebuild steps, valid steps are DHCP, DNS, TFTP, Content_Host_Status, Refresh_Content_Host_Status

Validations:

  • Must be an array of any type
>>>

GET /api/hosts/:id/template/:kind
Preview rendered provisioning template content

Params

Param name Description
location_id
optional

Set the current location context for the request

Validations:

  • Integer
organization_id
optional

Set the current organization context for the request

Validations:

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

Template kinds, available values: PXELinux, PXEGrub, PXEGrub2, iPXE, provision, finish, script, user_data, ZTP, POAP, cloud-init, host_init_config, registration, kexec, Bootdisk

Validations:

  • String
>>>

GET /api/hosts/:id/templates
Get provisioning templates for the host

Params

Param name Description
location_id
optional

Set the current location context for the request

Validations:

  • Integer
organization_id
optional

Set the current organization context for the request

Validations:

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

GET /api/hosts/:id/inherited_parameters
Get all inherited parameters for a host

Params

Param name Description
location_id
optional

Set the current location context for the request

Validations:

  • Integer
organization_id
optional

Set the current organization context for the request

Validations:

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

PUT /api/hosts/:host_id/host_collections
Alter a host's host collections

Params

Param name Description
location_id
optional

Set the current location context for the request

Validations:

  • Integer
organization_id
optional

Set the current organization context for the request

Validations:

  • Integer
host_id
required

The id of the host to alter

Validations:

  • Must be a number.
host_collection_ids
required

List of host collection ids to update

Validations:

  • Must be an array of any type