OPopenshift
installer

GET /v2/infra-envs/{infra_env_id}

Retrieves the details of the infra-env.

Request

  • Base URL
    http://api.openshift.com/api/assisted-install
  • URL
    http://api.openshift.com/api/assisted-install/v2/infra-envs/{infra_env_id}
  • Auth
    • API key in header Authorization
    • or API key in header X-Secret-Key
    • or API key in query parameter api_key
    • or API key in header Image-Token
    • or API key in query parameter image_token

Path parameters

infra_env_idstring uuid required

The infra-env to be retrieved.

Response

Success.

kind'InfraEnv' required

Indicates the type of this object.

idstring uuid required

Unique identifier of the object.

hrefstring required

Self link.

openshift_versionstring

Version of the OpenShift cluster (used to infer the RHCOS version - temporary until generic logic implemented).

namestring required

Name of the infra-env.

user_namestring
org_idstring
email_domainstring
os_streamstring

The OS stream to use for this infra-env (e.g. rhel-9, rhel-10). If unset, inherits from the associated cluster or uses the default OS stream.

additional_ntp_sourcesstring

A comma-separated list of NTP sources (name or IP) going to be added to all the hosts.

ntp_sourcesstring

A comma-separated list of NTP sources (name or IP) to be used as the only NTP configuration for hosts in this infra-env.

ssh_authorized_keystring

SSH public key for debugging the installation.

pull_secret_setboolean

True if the pull secret has been added to the cluster.

static_network_configstring

static network configuration string in the format expected by discovery ignition generation.

rendezvous_ipstring nullable

The IP address of the host that will act as the rendezvous (bootstrap) node for agent-based installations. This is optional for disconnected-iso image type and specifies which host will run the assisted service during the bootstrap phase. All other hosts will connect to this IP to coordinate the installation.

type'full-iso' | 'minimal-iso' | 'disconnected-iso' required
ignition_config_overridestring

Json formatted string containing the user overrides for the initial ignition config.

cluster_idstring uuid

If set, all hosts that register will be associated with the specified cluster.

size_bytesinteger
download_urlstring
generator_versionstring

Image generator version.

updated_atstring date-time required

The last time that this infra-env was updated.

created_atstring date-time required
expires_atstring date-time
cpu_architecture'x86_64' | 'aarch64' | 'arm64' | 'ppc64le' | 's390x'

The CPU architecture of the image (x86_64/arm64/etc).

kernel_argumentsstring nullable

JSON formatted string array representing the discovery image kernel arguments.

additional_trust_bundlestring

PEM-encoded X.509 certificate bundle. Hosts discovered by this infra-env will trust the certificates in this bundle. Clusters formed from the hosts discovered by this infra-env will also trust the certificates in this bundle.

network_discovery_delay_secondsinteger nullable

The number of seconds to wait before mapping host MACs to interfaces when applying static network config on minimal ISO. This can be used on hosts that need time to discover their NICs.

Changes

No recorded changes to this operation across all 54 revisions of this API.