Sign in

v52

latestSwagger 2.0Apache 2.0raw.githubusercontent.com2026-08-0381182251.7 KB
installer

Registers a new OpenShift agent.

post/v2/infra-envs/{infra_env_id}/hosts

Path parameters

infra_env_idstring uuid required

The infra-env that the agent is associated with.

Headers

discovery_agent_versionstring

The software version of the discovery agent that is registering the agent.

Request body

host_idstring uuid required
discovery_agent_versionstring

Response

Success.

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

idstring uuid required

Unique identifier of the object.

hrefstring required

Self link.

cluster_idstring uuid nullable

The cluster that this host is associated with.

infra_env_idstring 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_infostring required
validations_infostring

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_atstring date-time

The last time that the host status was updated.

stage_started_atstring date-time

Time at which the current progress stage started.

stage_updated_atstring date-time

Time at which the current progress stage was last updated.

progress_stagesHostStage[] nullable
connectivitystring
api_vip_connectivitystring

Contains a serialized api_vip_connectivity_response

tang_connectivitystring
inventorystring
free_addressesstring
ntp_sourcesstring

The configured NTP sources on the host.

disks_infostring

Additional information about disks, formatted as JSON.

role'auto-assign' | 'master' | 'arbiter' | 'worker' | 'bootstrap'
suggested_role'auto-assign' | 'master' | 'arbiter' | 'worker' | 'bootstrap'
bootstrapboolean
logs_collected_atstring date-time
logs_started_atstring date-time
installer_versionstring

Installer version.

installation_disk_pathstring

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_idstring

Contains the inventory disk id to install on.

updated_atstring date-time
created_atstring date-time
checked_in_atstring date-time

The last time the host's agent communicated with the service.

connection_timed_outboolean

Indicate that connection to assisted service was timed out when soft timeout is enabled.

registered_atstring date-time

The last time the host's agent tried to register in the service.

discovery_agent_versionstring
requested_hostnamestring
user_namestring
media_status'connected' | 'disconnected' nullable
{"stackTrail":"components:schemas:host_registration_response:allOf:properties:deleted_at","oasType":"schema","type":"unknown","description":"swagger:ignore","extensionFields":{"x-go-custom-tag":"gorm:\"type:timestamp with time zone;index\"","x-go-type":{"type":"DeletedAt","import":{"package":"gorm.io/gorm"},"hints":{"noValidation":true}}},"nullable":false}
ignition_config_overridesstring

Json formatted string containing the user overrides for the host's pointer ignition

installer_argsstring
timestampinteger

The time on the host as seconds since the Unix epoch.

machine_config_pool_namestring
images_statusstring

Array of image statuses.

domain_name_resolutionsstring

The domain name resolution result.

ignition_endpoint_token_setboolean

True if the token to fetch the ignition from ignition_endpoint_url is set.

node_labelsstring

Json containing node's labels.

disks_to_be_formattedstring

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_disksstring

A comma-seperated list of host disks that the service will avoid formatting.

fencing_credentialsstring

The host's BMC credentials that will be used in TNF.

Example response

{
  "installation_disk_path": "/dev/sda",
  "ignition_config_overrides": "{\"ignition\": {\"version\": \"3.1.0\"}, \"storage\": {\"files\": [{\"path\": \"/tmp/example\", \"contents\": {\"source\": \"data:text/plain;base64,aGVscGltdHJhcHBlZGluYXN3YWdnZXJzcGVj\"}}]}}"
}