GET /v2/clusters — assistedinstall

installer

Retrieves the list of OpenShift clusters.

get/v2/clusters

Query parameters

openshift_cluster_idstring uuid

A specific cluster to retrieve.

ams_subscription_idsstring[]

If non-empty, returned Clusters are filtered to those with matching subscription IDs.

with_hostsboolean

Include hosts in the returned list.

ownerstring

If provided, returns only clusters that are owned by the specified user.

Headers

get_unregistered_clustersboolean

Whether to return clusters that have been unregistered.

Response

Success.

kind'Cluster' | 'AddHostsCluster' required

Indicates the type of this object. Will be 'Cluster' if this is a complete object, 'AddHostsCluster' for cluster that add hosts to existing OCP cluster,

high_availability_mode'Full' | 'None'

Guaranteed availability of the installed cluster. 'Full' installs a Highly-Available cluster over multiple master nodes whereas 'None' installs a full cluster over one node.

idstring uuid required

Unique identifier of the object.

hrefstring required

Self link.

namestring

Name of the OpenShift cluster.

user_namestring

org_idstring

email_domainstring

openshift_versionstring

Version of the OpenShift cluster.

ocp_release_imagestring

OpenShift release image URI.

openshift_cluster_idstring uuid

Cluster ID on OCP system.

base_dns_domainstring

Base domain of the cluster. All DNS records must be sub-domains of this base and include the cluster name.

cluster_network_cidrstring

IP address block from which Pod IPs are allocated. This block must not overlap with existing physical networks. These IP addresses are used for the Pod network, and if you need to access the Pods from an external network, configure load balancers and routers to manage the traffic.

cluster_network_host_prefixinteger

The subnet prefix length to assign to each individual node. For example, if clusterNetworkHostPrefix is set to 23, then each node is assigned a /23 subnet out of the given cidr (clusterNetworkCIDR), which allows for 510 (2^(32 - 23) - 2) pod IPs addresses. If you are required to provide access to nodes from an external network, configure load balancers and routers to manage the traffic.

service_network_cidrstring

The IP address pool to use for service IP addresses. You can enter only one IP address pool. If you need to access the services from an external network, configure load balancers and routers to manage the traffic.

api_vip_dns_namestring nullable

The domain name used to reach the OpenShift cluster API.

machine_network_cidrstring

A CIDR that all hosts belonging to the cluster should have an interfaces with IP address that belongs to this CIDR. The api_vip belongs to this CIDR.

ssh_public_keystring

SSH public key for debugging OpenShift nodes.

http_proxystring

A proxy URL to use for creating HTTP connections outside the cluster. http://<username>:<pswd>@<ip>:<port>

https_proxystring

A proxy URL to use for creating HTTPS connections outside the cluster. http://<username>:<pswd>@<ip>:<port>

no_proxystring

A comma-separated list of destination domain names, domains, IP addresses, or other network CIDRs to exclude from proxying.

Status of the OpenShift cluster.

status_infostring required

Additional information pertaining to the status of the OpenShift cluster.

status_updated_atstring date-time

The last time that the cluster status was updated.

ready_host_countinteger

hosts associated to this cluster that are in 'known' state.

enabled_host_countinteger

hosts associated to this cluster that are not in 'disabled' state.

total_host_countinteger

All hosts associated to this cluster.

schedulable_mastersboolean

Schedule workloads on masters

schedulable_masters_forced_trueboolean

Indicates if schedule workloads on masters will be enabled regardless the value of 'schedulable_masters' property. Set to 'true' when not enough hosts are associated with this cluster to disable the scheduling on masters.

updated_atstring date-time

The last time that this cluster was updated.

created_atstring date-time

The time that this cluster was created.

install_started_atstring date-time

The time that this cluster started installation.

install_completed_atstring date-time

The time that this cluster completed installation.

pull_secret_setboolean

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

vip_dhcp_allocationboolean nullable

Indicate if virtual IP DHCP allocation mode is enabled.

validations_infostring

JSON-formatted string containing the validation results for each validation id grouped by category (network, hosts-data, etc.)

logs_info'requested' | 'collecting' | 'completed' | 'timeout' | ''

install_config_overridesstring

JSON-formatted string containing the user overrides for the install-config.yaml file.

controller_logs_collected_atstring date-time

controller_logs_started_atstring date-time

connectivity_majority_groupsstring

Json formatted string containing the majority groups for connectivity checks.

ip_collisionsstring

Json formatted string containing ip collisions detected in the cluster.

ignored_host_validationsstring

Json formatted string containing a list of host validations to be ignored. May also contain a list with a single string "all" to ignore all host validations. Some validations cannot be ignored.

ignored_cluster_validationsstring

Json formatted string containing a list of cluster validations to be ignored. May also contain a list with a single string "all" to ignore all cluster validations. Some validations cannot be ignored.

{"stackTrail":"components:schemas:cluster: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}

user_managed_networkingboolean nullable

(DEPRECATED) Indicate if the networking is managed by the user.

additional_ntp_sourcestring

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

ams_subscription_idstring uuid

Unique identifier of the AMS subscription in OCM.

hyperthreading'masters' | 'workers' | 'all' | 'none'

Enable/disable hyperthreading on master nodes, worker nodes, or all nodes

feature_usagestring

JSON-formatted string containing the usage information by feature name

network_type'OpenShiftSDN' | 'OVNKubernetes' nullable

The desired network type used.

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

importedboolean

Indicates whether this cluster is an imported day-2 cluster or a regular cluster. Clusters are considered imported when they are created via the ../clusters/import endpoint. Day-2 clusters converted from day-1 clusters by kube-api controllers or the ../clusters/<cluster_id>/actions/allow-add-hosts endpoint are not considered imported. Imported clusters usually lack a lot of information and are filled with default values that don't necessarily reflect the actual cluster they represent

tagsstring

A comma-separated list of tags that are associated to the cluster.

org_soft_timeouts_enabledboolean

Indication if organization soft timeouts is enabled for the cluster.

control_plane_countinteger

Specifies the required number of control plane nodes that should be part of the cluster.

Example response

[
  {
    "disk_encryption": {
      "tang_servers": "[{\"url\":\"http://tang.example.com:7500\",\"thumbprint\":\"PLjNyRdGw03zlRoGjQYMahSZGu9\"}, {\"url\":\"http://tang.example.com:7501\",\"thumbprint\":\"PLjNyRdGw03zlRoGjQYMahSZGu8\"}]"
    },
    "hosts": [
      {
        "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\"}}]}}"
      }
    ],
    "install_config_overrides": "{\"networking\":{\"networkType\": \"OVNKubernetes\"},\"fips\":true}"
  }
]

Query parameters

Headers

Response

Example response

Changes