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": "2024-02-22 18:15:42 UTC",
      "updated_at": "2024-02-22 18:15:42 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": "host1.example.com",
      "id": 980190962,
      "display_name": "host1.example.com",
      "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,
      "cockpit_url": 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": {
            "bugfix": 0,
            "security": 1,
            "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_facet_attributes": {
        "id": 980190962,
        "uuid": "uuid-1",
        "last_checkin": null,
        "service_level": null,
        "release_version": null,
        "autoheal": false,
        "registered_at": "2024-02-20 14:14:40 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": "2024-02-22 18:15:42 UTC",
      "updated_at": "2024-02-22 18:15:42 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": "host2.example.com",
      "id": 298486374,
      "display_name": "host2.example.com",
      "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,
      "cockpit_url": 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": {
            "bugfix": 0,
            "security": 1,
            "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_facet_attributes": {
        "id": 298486374,
        "uuid": "uuid-2",
        "last_checkin": null,
        "service_level": null,
        "release_version": null,
        "autoheal": false,
        "registered_at": "2024-02-20 14:14:40 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": "2024-02-22 18:15:42 UTC",
      "updated_at": "2024-02-22 18:15:42 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,
      "display_name": "host3.example.com",
      "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,
      "cockpit_url": 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": "host4.example.com",
      "image_id": null,
      "image_name": null,
      "created_at": "2024-02-22 18:15:42 UTC",
      "updated_at": "2024-02-22 18:15:42 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,
      "display_name": "host4.example.com",
      "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,
      "cockpit_url": 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": {
            "bugfix": 0,
            "security": 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": "2024-02-22 18:15:42 UTC",
      "updated_at": "2024-02-22 18:15:42 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,
      "display_name": "host5.example.com",
      "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,
      "cockpit_url": 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": 1073012837,
      "operatingsystem_name": "operatingsystem2 2",
      "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": "host61",
      "image_id": null,
      "image_name": null,
      "created_at": "2024-02-22 18:18:31 UTC",
      "updated_at": "2024-02-22 18:18:31 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": "host61",
      "id": 980191025,
      "display_name": "host61",
      "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,
      "cockpit_url": 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": 1073012838,
      "operatingsystem_name": "operatingsystem3 3",
      "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": "host62",
      "image_id": null,
      "image_name": null,
      "created_at": "2024-02-22 18:18:31 UTC",
      "updated_at": "2024-02-22 18:18:31 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",
      "errata_status": 0,
      "errata_status_label": "All errata applied",
      "name": "host62",
      "id": 980191026,
      "display_name": "host62",
      "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,
      "cockpit_url": null,
      "compute_resource_provider": null,
      "hostgroup_name": null,
      "hostgroup_title": null,
      "content_facet_attributes": {
        "id": 906413799,
        "uuid": "uuid-46",
        "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": {
            "bugfix": 0,
            "security": 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"
        }
      },
      "subscription_facet_attributes": {
        "id": 980191011,
        "uuid": "uuid-47-409",
        "last_checkin": null,
        "service_level": null,
        "release_version": null,
        "autoheal": false,
        "registered_at": "2024-02-20 14:14:40 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": "no-sub-facet.example.com",
      "image_id": null,
      "image_name": null,
      "created_at": "2024-02-22 18:15:42 UTC",
      "updated_at": "2024-02-22 18:15:42 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,
      "display_name": "no-sub-facet.example.com",
      "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,
      "cockpit_url": 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
applicable_debs string
applicable_errata string
applicable_errata_issued date
applicable_rpms string
architecture string
autoheal boolean
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_views string
created_at datetime
domain string
domain_id integer
errata_status security_needed, errata_needed, updated, unknown
execution_status ok, error
facts string
global_status ok, warning, error
has_ip string
has_ip6 string
has_mac string
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
ip string
ip6 string
job_invocation.id string
job_invocation.result cancelled, failed, pending, success
last_checkin datetime
last_report datetime
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
puppet_ca string
puppet_proxy_id integer
puppetmaster string
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
rhel_lifecycle_status full_support, maintenance_support, approaching_end_of_maintenance, extended_support, approaching_end_of_support, support_ended
role text
service_level string
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_uuid string
trace_status reboot_needed, process_restart_needed, updated
upgradable_debs string
upgradable_rpms string
usage text
user.firstname string
user.lastname string
user.login string
user.mail string
usergroup string
usergroup.name string
uuid string