Skip to content

openshift/api

URL for accessing the OpenShift API

This parameter stores the URL for accessing the OpenShift API server. It is automatically set during cluster installation and provides the endpoint for programmatic cluster management via oc, kubectl, or direct REST calls.

Requirements

  • Must be a valid HTTPS URL
  • Must be accessible from management networks
  • DNS must be properly configured
  • TLS certificates must be valid

Usage

API access pattern:

YAML
# URL format
https://api.<cluster_name>.<base_domain>:6443

# Example
https://api.cluster1.example.com:6443

# Provides access to:
- Kubernetes API
- OpenShift extended API
- Authentication endpoints
- Cluster resource management

Notes: - Set automatically after installation - Default port is 6443 - Used by oc/kubectl for cluster access - Required for programmatic cluster management

Objects that Reference openshift/api

Not used in current content packs

Objects used by openshift/api

Not used in current content packs