---
title: "GET /v2/clusters/{cluster_id}/hosts"
method: GET
path: "/v2/clusters/{cluster_id}/hosts"
tags: ["installer"]
---

# GET /v2/clusters/{cluster_id}/hosts

`GET /v2/clusters/{cluster_id}/hosts`

Get a list of cluster hosts according to supplied filters.

## Path parameters

- `cluster_id` string, uuid, required

## Query parameters

- `role` 'master' | 'arbiter' | 'worker' | 'auto-assign'
- `status` string
- `with-inventory` boolean
- `with-connectivity` boolean

## Response `200`

Success.

- Host[]
  - `kind` 'Host' | 'AddToExistingClusterHost', required — Indicates the type of this object. Will be 'Host' if this is a complete object or 'HostLink' if it is just a link, or 'AddToExistingClusterHost' for host being added to existing OCP cluster, or
  - `id` string, uuid, required — Unique identifier of the object.
  - `href` string, required — Self link.
  - `cluster_id` string, uuid, nullable — The cluster that this host is associated with.
  - `infra_env_id` string, uuid — The infra-env that this host is associated with.
  - `status` 'discovering' | 'known' | 'disconnected' | 'insufficient' | 'disabled' | 'preparing-for-installation' | 'preparing-failed' | 'preparing-successful' | 'pending-for-input' | 'installing' | 'installing-in-progress' | 'installing-pending-user-action' | 'resetting-pending-user-action' | 'installed' | 'error' | 'resetting' | 'added-to-existing-cluster' | 'cancelled' | 'binding' | 'unbinding' | 'unbinding-pending-user-action' | 'known-unbound' | 'disconnected-unbound' | 'insufficient-unbound' | 'disabled-unbound' | 'discovering-unbound' | 'reclaiming' | 'reclaiming-rebooting', required
  - `status_info` string, required
  - `validations_info` string — JSON-formatted string containing the validation results for each validation id grouped by category (network, hardware, etc.)
  - `logs_info` 'requested' | 'collecting' | 'completed' | 'timeout' | ''
  - `status_updated_at` string, date-time — The last time that the host status was updated.
  - `progress` HostProgressInfo
    - `installation_percentage` integer
    - `current_stage` 'Starting installation' | 'Waiting for control plane' | 'Waiting for bootkube' | 'Waiting for controller' | 'Installing' | 'Writing image to disk' | 'Copying registry data to disk' | 'Rebooting' | 'Waiting for ignition' | 'Configuring' | 'Joined' | 'Done' | 'Failed'
    - `progress_info` string
    - `stage_started_at` string, date-time — Time at which the current progress stage started.
    - `stage_updated_at` string, date-time — Time at which the current progress stage was last updated.
    - `stage_timed_out` boolean — Indicate of the current stage has been timed out.
  - `stage_started_at` string, date-time — Time at which the current progress stage started.
  - `stage_updated_at` string, date-time — Time at which the current progress stage was last updated.
  - `progress_stages` HostStage[], nullable
  - `connectivity` string
  - `api_vip_connectivity` string — Contains a serialized api_vip_connectivity_response
  - `tang_connectivity` string
  - `inventory` string
  - `free_addresses` string
  - `ntp_sources` string — The configured NTP sources on the host.
  - `disks_info` string — Additional information about disks, formatted as JSON.
  - `role` 'auto-assign' | 'master' | 'arbiter' | 'worker' | 'bootstrap'
  - `suggested_role` 'auto-assign' | 'master' | 'arbiter' | 'worker' | 'bootstrap'
  - `bootstrap` boolean
  - `logs_collected_at` string, date-time
  - `logs_started_at` string, date-time
  - `installer_version` string — Installer version.
  - `installation_disk_path` string — Contains the inventory disk path, This field is replaced by installation_disk_id field and used for backward compatability with the old UI.
  - `installation_disk_id` string — Contains the inventory disk id to install on.
  - `updated_at` string, date-time
  - `created_at` string, date-time
  - `checked_in_at` string, date-time — The last time the host's agent communicated with the service.
  - `connection_timed_out` boolean — Indicate that connection to assisted service was timed out when soft timeout is enabled.
  - `registered_at` string, date-time — The last time the host's agent tried to register in the service.
  - `discovery_agent_version` string
  - `requested_hostname` string
  - `user_name` string
  - `media_status` 'connected' | 'disconnected', nullable
  - `deleted_at` unknown
  - `ignition_config_overrides` string — Json formatted string containing the user overrides for the host's pointer ignition
  - `installer_args` string
  - `timestamp` integer — The time on the host as seconds since the Unix epoch.
  - `machine_config_pool_name` string
  - `images_status` string — Array of image statuses.
  - `domain_name_resolutions` string — The domain name resolution result.
  - `ignition_endpoint_token_set` boolean — True if the token to fetch the ignition from ignition_endpoint_url is set.
  - `node_labels` string — Json containing node's labels.
  - `disks_to_be_formatted` string — A comma-separated list of disks that will be formatted once installation begins, unless otherwise set to be skipped by skip_formatting_disks. This means that this list also includes disks that appear in skip_formatting_disks. This property is managed by the service and cannot be modified by the user.
  - `skip_formatting_disks` string — A comma-seperated list of host disks that the service will avoid formatting.
  - `fencing_credentials` string — The host's BMC credentials that will be used in TNF.

## Other responses

- `401` — Unauthorized.
- `403` — Forbidden.
- `404` — Error.
- `500` — Error.

---

[API](https://skmtc.net/openshift/apis/assistedinstall.md) · [All operations](https://skmtc.net/openshift/apis/assistedinstall/llms.txt) · [OpenAPI document](https://skmtc-service-staging.skmtc.workers.dev/v1/apis/openshift/assistedinstall/versions/9d0b4936ca97/schema)