Red Hat OpenShift

Red Hat OpenShift is an enterprise Kubernetes platform that provides a consistent hybrid cloud foundation for building, deploying, and scaling containerized applications. OpenShift extends Kubernetes with developer productivity tools, built-in CI/CD pipelines, integrated monitoring and logging, automated cluster management, role-based access control, and security policies. It supports deployments on bare metal, virtual machines, public clouds, and managed OpenShift services (ROSA, ARO, RHOIC). The OpenShift REST API exposes hundreds of Kubernetes and OpenShift-specific resource types organized into API groups for workload management, networking, storage, security, builds, pipelines, and cluster configuration.

7 APIs 0 Features

ContainersEnterpriseHybrid CloudKubernetesPaaSRed Hat

APIs

Red Hat OpenShift Container Platform API

The OpenShift Container Platform REST API is a Kubernetes-compatible REST API that extends the core Kubernetes API with OpenShift-specific resources. It provides programmatic ac...

Red Hat OpenShift Cluster Manager API

The OpenShift Cluster Manager (OCM) API provides programmatic access to the Red Hat Hybrid Cloud Console for managing OpenShift clusters at scale. Operations include creating, u...

Red Hat OpenShift Pipelines (Tekton) API

OpenShift Pipelines is a cloud-native CI/CD solution based on Tekton that runs pipelines as Kubernetes-native CRDs. The API provides resources for defining Tasks (individual ste...

Red Hat OpenShift GitOps (ArgoCD) API

OpenShift GitOps is built on Argo CD and provides a GitOps continuous delivery solution for OpenShift clusters. The API exposes Application, AppProject, ApplicationSet, and Repo...

Red Hat OpenShift Service Mesh API

Red Hat OpenShift Service Mesh, based on Istio, Kiali, Jaeger, and Prometheus, provides traffic management, security, and observability for microservices. The Service Mesh API e...

Red Hat OpenShift Serverless (Knative) API

OpenShift Serverless, based on Knative, enables deploying and managing event-driven serverless workloads on OpenShift. The Serverless API exposes Knative Serving resources (Serv...

Red Hat OpenShift Service on AWS (ROSA) API

Red Hat OpenShift Service on AWS (ROSA) is a fully managed OpenShift service co-managed by Red Hat and AWS. The ROSA API, exposed through the OCM service, provides operations fo...

Collections

Red Hat OpenShift Container Platform API

OPEN

Red Hat OpenShift Cluster Manager API

OPEN

Pricing Plans

Red Hat Openshift Plans Pricing

8 plans

PLANS

Rate Limits

Red Hat Openshift Rate Limits

2 limits

RATE LIMITS

FinOps

Red Hat Openshift Finops

FINOPS

Semantic Vocabularies

Red Hat Openshift Context

3 classes · 20 properties

JSON-LD

API Governance Rules

Red Hat OpenShift API Rules

13 rules · 6 errors 4 warnings 3 info

SPECTRAL

JSON Structure

Red Hat Openshift Project Structure

0 properties

JSON STRUCTURE

Red Hat Openshift Structure

0 properties

JSON STRUCTURE

Example Payloads

Red Hat Openshift Create Project Example

2 fields

EXAMPLE

Red Hat Openshift Create Route Example

2 fields

EXAMPLE

Resources

Documentation

GitHubOrganization

GitHubOrganization

PrivacyPolicy

TermsOfService

JSONLDContext

JSONStructure

SpectralRuleset

SpectralRuleset

Sources

opencollection: 1.0.0
info:
  name: Red Hat OpenShift Cluster Manager API
  version: '1'
request:
  auth:
    type: bearer
    token: '{{bearerToken}}'
items:
- info:
    name: Clusters
    type: folder
  items:
  - info:
      name: List Clusters
      type: http
    http:
      method: GET
      url: https://api.openshift.com/api/clusters_mgmt/v1/clusters
      params:
      - name: page
        value: ''
        type: query
        description: Page number for pagination (1-indexed)
      - name: size
        value: ''
        type: query
        description: Number of results per page
      - name: search
        value: ''
        type: query
        description: SQL-like search expression for filtering
      - name: order
        value: ''
        type: query
        description: SQL-like ORDER BY clause
    docs: Returns a list of OpenShift clusters registered with the Cluster Manager. Supports filtering by cloud provider,
      region, version, and state. Results are paginated.
  - info:
      name: Create Cluster
      type: http
    http:
      method: POST
      url: https://api.openshift.com/api/clusters_mgmt/v1/clusters
      body:
        type: json
        data: '{}'
    docs: Creates a new OpenShift cluster on the specified cloud provider and region. Supports ROSA (AWS), ARO (Azure), and
      other OpenShift flavors.
  - info:
      name: Get Cluster
      type: http
    http:
      method: GET
      url: https://api.openshift.com/api/clusters_mgmt/v1/clusters/:cluster_id
      params:
      - name: cluster_id
        value: ''
        type: path
        description: The cluster identifier
    docs: Returns detailed information about a specific OpenShift cluster.
  - info:
      name: Update Cluster
      type: http
    http:
      method: PATCH
      url: https://api.openshift.com/api/clusters_mgmt/v1/clusters/:cluster_id
      params:
      - name: cluster_id
        value: ''
        type: path
        description: The cluster identifier
      body:
        type: json
        data: '{}'
    docs: Updates an existing cluster configuration (partial update).
  - info:
      name: Delete Cluster
      type: http
    http:
      method: DELETE
      url: https://api.openshift.com/api/clusters_mgmt/v1/clusters/:cluster_id
      params:
      - name: cluster_id
        value: ''
        type: path
        description: The cluster identifier
    docs: Deletes an OpenShift cluster. This operation is irreversible.
- info:
    name: Add-ons
    type: folder
  items:
  - info:
      name: List Cluster Add-ons
      type: http
    http:
      method: GET
      url: https://api.openshift.com/api/clusters_mgmt/v1/clusters/:cluster_id/addons
      params:
      - name: cluster_id
        value: ''
        type: path
        description: The cluster identifier
    docs: Returns a list of add-ons installed on the specified cluster.
  - info:
      name: Install Cluster Add-on
      type: http
    http:
      method: POST
      url: https://api.openshift.com/api/clusters_mgmt/v1/clusters/:cluster_id/addons
      params:
      - name: cluster_id
        value: ''
        type: path
        description: The cluster identifier
      body:
        type: json
        data: '{}'
    docs: Installs a new add-on on the specified cluster.
- info:
    name: Identity Providers
    type: folder
  items:
  - info:
      name: List Identity Providers
      type: http
    http:
      method: GET
      url: https://api.openshift.com/api/clusters_mgmt/v1/clusters/:cluster_id/identity_providers
      params:
      - name: cluster_id
        value: ''
        type: path
        description: The cluster identifier
    docs: Returns the identity providers configured for cluster authentication.
  - info:
      name: Create Identity Provider
      type: http
    http:
      method: POST
      url: https://api.openshift.com/api/clusters_mgmt/v1/clusters/:cluster_id/identity_providers
      params:
      - name: cluster_id
        value: ''
        type: path
        description: The cluster identifier
      body:
        type: json
        data: '{}'
    docs: Adds an identity provider to the cluster for user authentication.
- info:
    name: Machine Pools
    type: folder
  items:
  - info:
      name: List Machine Pools
      type: http
    http:
      method: GET
      url: https://api.openshift.com/api/clusters_mgmt/v1/clusters/:cluster_id/machine_pools
      params:
      - name: cluster_id
        value: ''
        type: path
        description: The cluster identifier
    docs: Returns the machine pools (node groups) configured for the cluster.
  - info:
      name: Create Machine Pool
      type: http
    http:
      method: POST
      url: https://api.openshift.com/api/clusters_mgmt/v1/clusters/:cluster_id/machine_pools
      params:
      - name: cluster_id
        value: ''
        type: path
        description: The cluster identifier
      body:
        type: json
        data: '{}'
    docs: Creates a new machine pool for the cluster.
- info:
    name: Versions
    type: folder
  items:
  - info:
      name: List OpenShift Versions
      type: http
    http:
      method: GET
      url: https://api.openshift.com/api/clusters_mgmt/v1/versions
      params:
      - name: search
        value: ''
        type: query
        description: Filter versions by search expression
    docs: Returns the list of available OpenShift versions for cluster creation.
bundled: true