GET /foreman_virt_who_configure/api/v2/configs
List of virt-who configurations

GET /foreman_virt_who_configure/api/v2/organizations/:organization_id/configs
List of virt-who configurations per organization

Examples

GET /foreman_virt_who_configure/api/configs
200
{
  "total": 3,
  "subtotal": 3,
  "page": 1,
  "per_page": 20,
  "search": null,
  "sort": {
    "by": null,
    "order": null
  },
  "results": [
    {
      "name": "my vmware",
      "interval": 120,
      "organization_id": 447626467,
      "whitelist": "a,b",
      "blacklist": null,
      "hypervisor_id": "hostname",
      "hypervisor_type": "esx",
      "hypervisor_server": "vmware.example.com",
      "hypervisor_username": "root",
      "debug": false,
      "satellite_url": "foreman.example.com",
      "no_proxy": null,
      "status": "unknown",
      "last_report_at": null,
      "out_of_date_at": null,
      "filter_host_parents": null,
      "exclude_host_parents": null,
      "kubeconfig_path": null,
      "prism_flavor": null,
      "ahv_internal_debug": null,
      "filtering_mode": 1,
      "id": 27,
      "http_proxy": {
        "id": 1022235412,
        "name": "test",
        "url": "http://test.com"
      },
      "proxy": "http://test.com"
    },
    {
      "name": "config 27",
      "interval": 120,
      "organization_id": 447626468,
      "whitelist": null,
      "blacklist": null,
      "hypervisor_id": "hostname",
      "hypervisor_type": "esx",
      "hypervisor_server": "vmware.example.com",
      "hypervisor_username": "root",
      "debug": false,
      "satellite_url": "foreman.example.com",
      "no_proxy": null,
      "status": "out_of_date",
      "last_report_at": "2024-05-23 17:43:53 UTC",
      "out_of_date_at": "2024-05-23 19:43:53 UTC",
      "filter_host_parents": null,
      "exclude_host_parents": null,
      "kubeconfig_path": null,
      "prism_flavor": null,
      "ahv_internal_debug": null,
      "filtering_mode": 0,
      "id": 28,
      "http_proxy": null
    },
    {
      "name": "config 28",
      "interval": 120,
      "organization_id": 447626469,
      "whitelist": null,
      "blacklist": null,
      "hypervisor_id": "hostname",
      "hypervisor_type": "esx",
      "hypervisor_server": "vmware.example.com",
      "hypervisor_username": "root",
      "debug": false,
      "satellite_url": "foreman.example.com",
      "no_proxy": null,
      "status": "ok",
      "last_report_at": "2024-05-23 19:43:53 UTC",
      "out_of_date_at": "2024-05-23 21:43:53 UTC",
      "filter_host_parents": null,
      "exclude_host_parents": null,
      "kubeconfig_path": null,
      "prism_flavor": null,
      "ahv_internal_debug": null,
      "filtering_mode": 0,
      "id": 29,
      "http_proxy": null
    }
  ]
}

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
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$/.