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.
Red Hat OpenShift publishes 40 APIs on the APIs.io network, including Add-ons API, Builds API, Clusters API, and 37 more. Tagged areas include Containers, Enterprise, Hybrid Cloud, Kubernetes, and Platform-as-a-Service.
The Red Hat OpenShift catalog on APIs.io includes 1 JSON-LD context and 2 Spectral governance rulesets.
Red Hat OpenShift’s developer surface includes authentication, documentation, pricing, engineering blog, signup flow, support, training material, and 16 more developer resources.
2 APIs
Individual APIs this provider publishes, each with its own machine-readable definition.
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...
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, based on Istio, Kiali, Jaeger, and Prometheus, provides traffic management, security, and observability for microservices. The Service Mesh API e...
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) is a fully managed OpenShift service co-managed by Red Hat and AWS. The ROSA API, exposed through the OCM service, provides operations fo...
Manage cluster add-on installations
Build and BuildConfig resources for source-to-image and Dockerfile builds
Manage OpenShift clusters across cloud providers
DeploymentConfig resources for OpenShift-native deployment management
Configure authentication providers for clusters
ImageStream and ImageStreamTag resources for container image management
Manage compute node pools for clusters
OpenShift Project resources for multi-tenant workspace management
Route resources for exposing services via HTTP/HTTPS hostnames
SCC resources for controlling pod security permissions
Query available OpenShift versions
OAuth authentication and authorization API for OpenShift.
API for managing application builds and build configurations.
API for managing container images and image streams.
API for managing OpenShift projects (namespace extensions).
API for managing workload resources including Pods, Deployments, DeploymentConfigs, StatefulSets, Jobs, CronJobs, ReplicaSets, and DaemonSets.
API for managing network configuration including Services, Endpoints, Ingress, NetworkPolicy, and EgressFirewall resources.
API for managing storage resources including PersistentVolumes, PersistentVolumeClaims, StorageClasses, CSI drivers, and VolumeSnapshots.
API for managing authorization resources including SubjectAccessReview, SelfSubjectAccessReview, LocalSubjectAccessReview, and TokenReview.
API for managing autoscaling resources including HorizontalPodAutoscaler, ClusterAutoscaler, and MachineAutoscaler.
API for managing cluster configuration resources including APIServer, Authentication, Infrastructure, Ingress, Network, OAuth, and Scheduler configuration.
API for managing OpenShift web console extensions including ConsoleCLIDownload, ConsoleExternalLogLink, ConsoleLink, ConsoleNotification, and ConsolePlugin.
API for managing cluster-level resources including ClusterVersion, ClusterOperator, and infrastructure resources.
API for managing machine resources including Machine, MachineSet, MachineHealthCheck, and MachineAutoscaler for cluster node lifecycle management.
API for managing OpenShift operator lifecycle and configuration including Etcd, Console, Network, DNS, IngressController, and other operator resources.
API for managing OperatorHub resources including CatalogSources, Subscriptions, InstallPlans, and ClusterServiceVersions for the Operator Lifecycle Manager.
API for managing templates that provide parameterized sets of objects for creating applications and services.
API for managing security resources including SecurityContextConstraints, RangeAllocation, and PodSecurityPolicyReview for controlling pod security.
API for managing role-based access control resources including Roles, ClusterRoles, RoleBindings, and ClusterRoleBindings.
API for managing node-level resources including Node, RuntimeClass, and node configuration.
API for managing monitoring and observability resources including Prometheus, Alertmanager, ServiceMonitor, and PrometheusRule.
API for managing bare metal and infrastructure provisioning resources including BareMetalHost, Provisioning, and hardware management.
API for managing scheduling and quota resources including ResourceQuota, LimitRange, PriorityClass, and ClusterResourceQuota.
API for managing metadata resources including ConfigMaps, Secrets, Events, Namespaces, and ServiceAccounts.
Managed service API for installing, modifying, operating, and upgrading Red Hat OpenShift clusters across cloud providers.
Ready-to-run Postman collections for exercising this provider's APIs.
Open, tool-agnostic API collections (OpenAPI-derived and Bruno).
Published pricing tiers and plan structures.
Documented rate limits and quota policies.
Cost, billing, and metering signals for API financial operations.
JSON-LD contexts and semantic vocabularies used across these APIs.
Spectral governance rulesets for linting and validating these APIs.
Standalone JSON Schema definitions for this provider's data models.
JSON Structure definitions describing this provider's data shapes.
Example request and response payloads for these APIs.
Authentication, domain security, vulnerability disclosure, and trust-center signals.
Recommended x-agentic-access execution contracts for AI agents.
aid: red-hat-openshift
name: Red Hat OpenShift
description: 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.
type: Index
deliveryModel:
model: saas
license_evidence:
not_product:
- openshift/gitops-operator
- openshift/pipelines-as-code
open_source: unknown
commercial: true
callable_host: true
label: Hosted service · you call their endpoint
confidence: low
source:
- openapi
- pricing
- repository-not-product
generated: '2026-09-25'
method: derived
accessModel:
pricing: paid
onboarding: unknown
trial: false
try_now: false
public: false
label: Paid
confidence: medium
source:
- plans
- authentication
- security
generated: '2026-09-03'
method: derived
image: https://kinlane-images.s3.amazonaws.com/shared/apis-json/icons/red-hat-openshift.png
tags:
- Containers
- Enterprise
- Hybrid Cloud
- Kubernetes
- Platform-as-a-Service
- Red Hat
tags_raw:
- Containers
- Enterprise
- Hybrid Cloud
- Kubernetes
- PaaS
- Red Hat
url: https://raw.githubusercontent.com/api-evangelist/red-hat-openshift/refs/heads/main/apis.yml
created: '2026-03-26'
modified: '2026-09-16'
specificationVersion: '0.23'
apis:
- aid: red-hat-openshift:openshift-pipelines-api
name: Red Hat OpenShift Pipelines (Tekton) API
description: 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 steps), Pipelines (task graphs), PipelineRuns (pipeline
executions), TaskRuns, Workspaces, TriggerTemplates, and EventListeners for event-driven pipeline automation. All pipeline
resources are managed through the Kubernetes API server using the tekton.dev API group.
humanURL: https://docs.openshift.com/container-platform/latest/cicd/pipelines/understanding-openshift-pipelines.html
baseURL: https://api.cluster.example.com:6443/apis/tekton.dev/v1
tags:
- CI/CD
- Kubernetes
- Pipelines
- Tekton
properties:
- type: Documentation
url: https://docs.openshift.com/container-platform/latest/cicd/pipelines/understanding-openshift-pipelines.html
- type: GitHub
url: https://github.com/openshift/pipelines-as-code
- aid: red-hat-openshift:openshift-gitops-api
name: Red Hat OpenShift GitOps (ArgoCD) API
description: OpenShift GitOps is built on Argo CD and provides a GitOps continuous delivery solution for OpenShift clusters.
The API exposes Application, AppProject, ApplicationSet, and Repository CRD resources for declarative cluster state management
from Git repositories. The ArgoCD API also includes a REST gRPC-gateway API for direct interaction with the ArgoCD server.
humanURL: https://docs.openshift.com/container-platform/latest/cicd/gitops/understanding-openshift-gitops.html
baseURL: https://api.cluster.example.com:6443/apis/argoproj.io/v1alpha1
tags:
- ArgoCD
- CI/CD
- GitOps
- Kubernetes
properties:
- type: Documentation
url: https://docs.openshift.com/container-platform/latest/cicd/gitops/understanding-openshift-gitops.html
- type: GitHub
url: https://github.com/openshift/gitops-operator
- aid: red-hat-openshift:openshift-service-mesh-api
name: Red Hat OpenShift Service Mesh API
description: Red Hat OpenShift Service Mesh, based on Istio, Kiali, Jaeger, and Prometheus, provides traffic management,
security, and observability for microservices. The Service Mesh API exposes Istio CRDs including VirtualService, DestinationRule,
ServiceEntry, Gateway, PeerAuthentication, AuthorizationPolicy, and Telemetry resources for configuring service-to-service
communication, mutual TLS, and distributed tracing policies.
humanURL: https://docs.openshift.com/container-platform/latest/service_mesh/v2x/ossm-about.html
baseURL: https://api.cluster.example.com:6443/apis/networking.istio.io/v1beta1
tags:
- Istio
- Kubernetes
- Service Mesh
- Traffic Management
properties:
- type: Documentation
url: https://docs.openshift.com/container-platform/latest/service_mesh/v2x/ossm-about.html
- aid: red-hat-openshift:openshift-serverless-api
name: Red Hat OpenShift Serverless (Knative) API
description: OpenShift Serverless, based on Knative, enables deploying and managing event-driven serverless workloads on
OpenShift. The Serverless API exposes Knative Serving resources (Service, Route, Configuration, Revision) for auto-scaling
workloads and Knative Eventing resources (Broker, Trigger, Channel, Subscription, EventSource) for event-driven architectures.
Resources are managed through the serving.knative.dev and eventing.knative.dev API groups.
humanURL: https://docs.openshift.com/serverless/latest/about/about-serverless.html
baseURL: https://api.cluster.example.com:6443/apis/serving.knative.dev/v1
tags:
- Event-Driven
- Knative
- Kubernetes
- Serverless
properties:
- type: Documentation
url: https://docs.openshift.com/serverless/latest/about/about-serverless.html
- aid: red-hat-openshift:rosa-api
name: Red Hat OpenShift Service on AWS (ROSA) API
description: 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 for creating and managing ROSA clusters, configuring
machine pools, managing identity providers, setting up private link connectivity, and monitoring cluster status. ROSA
clusters also expose the full OpenShift API endpoint after provisioning.
humanURL: https://docs.openshift.com/rosa/rosa_architecture/rosa-understanding.html
baseURL: https://api.openshift.com/api/clusters_mgmt/v1
tags:
- AWS
- Cloud
- Managed Service
- OpenShift
properties:
- type: Documentation
url: https://docs.openshift.com/rosa/rosa_architecture/rosa-understanding.html
- type: GettingStarted
url: https://docs.openshift.com/rosa/rosa_getting_started/rosa-getting-started-iam-prerequisites.html
- aid: red-hat-openshift:red-hat-openshift-add-ons-api
name: Red Hat OpenShift Add-ons API
description: Manage cluster add-on installations
humanURL: https://docs.openshift.com/container-platform/latest/rest_api/index.html
baseURL: https://api.cluster.example.com:6443
tags:
- Addons
tags_raw:
- Add-ons
properties:
- type: OpenAPI
url: openapi/red-hat-openshift-add-ons-api-openapi.yml
- type: Documentation
url: https://docs.openshift.com/container-platform/latest/rest_api/index.html
- type: GettingStarted
url: https://developers.redhat.com/products/openshift/getting-started
- type: Documentation
url: https://api.openshift.com/
- aid: red-hat-openshift:red-hat-openshift-builds-api
name: Red Hat OpenShift Builds API
description: Build and BuildConfig resources for source-to-image and Dockerfile builds
humanURL: https://docs.openshift.com/container-platform/latest/rest_api/index.html
baseURL: https://api.cluster.example.com:6443
tags:
- Builds
properties:
- type: OpenAPI
url: openapi/red-hat-openshift-builds-api-openapi.yml
- type: Documentation
url: https://docs.openshift.com/container-platform/latest/rest_api/index.html
- type: GettingStarted
url: https://developers.redhat.com/products/openshift/getting-started
- type: Documentation
url: https://api.openshift.com/
- aid: red-hat-openshift:red-hat-openshift-clusters-api
name: Red Hat OpenShift Clusters API
description: Manage OpenShift clusters across cloud providers
humanURL: https://docs.openshift.com/container-platform/latest/rest_api/index.html
baseURL: https://api.cluster.example.com:6443
tags:
- Cluster
tags_raw:
- Clusters
properties:
- type: OpenAPI
url: openapi/red-hat-openshift-clusters-api-openapi.yml
- type: Documentation
url: https://docs.openshift.com/container-platform/latest/rest_api/index.html
- type: GettingStarted
url: https://developers.redhat.com/products/openshift/getting-started
- type: Documentation
url: https://api.openshift.com/
- aid: red-hat-openshift:red-hat-openshift-deployment-configs-api
name: Red Hat OpenShift Deployment Configs API
description: DeploymentConfig resources for OpenShift-native deployment management
humanURL: https://docs.openshift.com/container-platform/latest/rest_api/index.html
baseURL: https://api.cluster.example.com:6443
tags:
- Deployment Configs
properties:
- type: OpenAPI
url: openapi/red-hat-openshift-deployment-configs-api-openapi.yml
- type: Documentation
url: https://docs.openshift.com/container-platform/latest/rest_api/index.html
- type: GettingStarted
url: https://developers.redhat.com/products/openshift/getting-started
- type: Documentation
url: https://api.openshift.com/
- aid: red-hat-openshift:red-hat-openshift-identity-providers-api
name: Red Hat OpenShift Identity Providers API
description: Configure authentication providers for clusters
humanURL: https://docs.openshift.com/container-platform/latest/rest_api/index.html
baseURL: https://api.cluster.example.com:6443
tags:
- Identity Providers
properties:
- type: OpenAPI
url: openapi/red-hat-openshift-identity-providers-api-openapi.yml
- type: Documentation
url: https://docs.openshift.com/container-platform/latest/rest_api/index.html
- type: GettingStarted
url: https://developers.redhat.com/products/openshift/getting-started
- type: Documentation
url: https://api.openshift.com/
- aid: red-hat-openshift:red-hat-openshift-image-streams-api
name: Red Hat OpenShift Image Streams API
description: ImageStream and ImageStreamTag resources for container image management
humanURL: https://docs.openshift.com/container-platform/latest/rest_api/index.html
baseURL: https://api.cluster.example.com:6443
tags:
- Image Streams
properties:
- type: OpenAPI
url: openapi/red-hat-openshift-image-streams-api-openapi.yml
- type: Documentation
url: https://docs.openshift.com/container-platform/latest/rest_api/index.html
- type: GettingStarted
url: https://developers.redhat.com/products/openshift/getting-started
- type: Documentation
url: https://api.openshift.com/
- aid: red-hat-openshift:red-hat-openshift-machine-pools-api
name: Red Hat OpenShift Machine Pools API
description: Manage compute node pools for clusters
humanURL: https://docs.openshift.com/container-platform/latest/rest_api/index.html
baseURL: https://api.cluster.example.com:6443
tags:
- Machine Pools
properties:
- type: OpenAPI
url: openapi/red-hat-openshift-machine-pools-api-openapi.yml
- type: Documentation
url: https://docs.openshift.com/container-platform/latest/rest_api/index.html
- type: GettingStarted
url: https://developers.redhat.com/products/openshift/getting-started
- type: Documentation
url: https://api.openshift.com/
- aid: red-hat-openshift:red-hat-openshift-projects-api
name: Red Hat OpenShift Projects API
description: OpenShift Project resources for multi-tenant workspace management
humanURL: https://docs.openshift.com/container-platform/latest/rest_api/index.html
baseURL: https://api.cluster.example.com:6443
tags:
- Project
tags_raw:
- Projects
properties:
- type: OpenAPI
url: openapi/red-hat-openshift-projects-api-openapi.yml
- type: Documentation
url: https://docs.openshift.com/container-platform/latest/rest_api/index.html
- type: GettingStarted
url: https://developers.redhat.com/products/openshift/getting-started
- type: Documentation
url: https://api.openshift.com/
- aid: red-hat-openshift:red-hat-openshift-routes-api
name: Red Hat OpenShift Routes API
description: Route resources for exposing services via HTTP/HTTPS hostnames
humanURL: https://docs.openshift.com/container-platform/latest/rest_api/index.html
baseURL: https://api.cluster.example.com:6443
tags:
- Routes
properties:
- type: OpenAPI
url: openapi/red-hat-openshift-routes-api-openapi.yml
- type: Documentation
url: https://docs.openshift.com/container-platform/latest/rest_api/index.html
- type: GettingStarted
url: https://developers.redhat.com/products/openshift/getting-started
- type: Documentation
url: https://api.openshift.com/
- aid: red-hat-openshift:red-hat-openshift-security-context-constraints-api
name: Red Hat OpenShift Security Context Constraints API
description: SCC resources for controlling pod security permissions
humanURL: https://docs.openshift.com/container-platform/latest/rest_api/index.html
baseURL: https://api.cluster.example.com:6443
tags:
- Security Context Constraints
properties:
- type: OpenAPI
url: openapi/red-hat-openshift-security-context-constraints-api-openapi.yml
- type: Documentation
url: https://docs.openshift.com/container-platform/latest/rest_api/index.html
- type: GettingStarted
url: https://developers.redhat.com/products/openshift/getting-started
- type: Documentation
url: https://api.openshift.com/
- aid: red-hat-openshift:red-hat-openshift-versions-api
name: Red Hat OpenShift Versions API
description: Query available OpenShift versions
humanURL: https://docs.openshift.com/container-platform/latest/rest_api/index.html
baseURL: https://api.cluster.example.com:6443
tags:
- Versions
properties:
- type: OpenAPI
url: openapi/red-hat-openshift-versions-api-openapi.yml
- type: Documentation
url: https://docs.openshift.com/container-platform/latest/rest_api/index.html
- type: GettingStarted
url: https://developers.redhat.com/products/openshift/getting-started
- type: Documentation
url: https://api.openshift.com/
- name: OpenShift OAuth API
description: OAuth authentication and authorization API for OpenShift.
humanURL: https://docs.openshift.com/container-platform/latest/authentication/understanding-authentication.html
baseURL: https://oauth-openshift.apps.openshift.com
tags:
- Authentication
- Security
tags_raw:
- Authentication
- OAuth
- Security
properties:
- type: Documentation
url: https://docs.openshift.com/container-platform/latest/authentication/understanding-authentication.html
- name: OpenShift Build API
description: API for managing application builds and build configurations.
humanURL: https://docs.openshift.com/container-platform/latest/cicd/builds/understanding-builds.html
baseURL: https://api.openshift.com/apis/build.openshift.io/v1
tags:
- Builds
- CI/CD
- Source-To-Image
properties:
- type: Documentation
url: https://docs.openshift.com/container-platform/latest/cicd/builds/understanding-builds.html
- name: OpenShift Image API
description: API for managing container images and image streams.
humanURL: https://docs.openshift.com/container-platform/latest/openshift_images/index.html
baseURL: https://api.openshift.com/apis/image.openshift.io/v1
tags:
- Containers
- Image
- Registry
tags_raw:
- Containers
- Images
- Registry
properties:
- type: Documentation
url: https://docs.openshift.com/container-platform/latest/openshift_images/index.html
- name: OpenShift Project API
description: API for managing OpenShift projects (namespace extensions).
humanURL: https://docs.openshift.com/container-platform/latest/applications/projects/working-with-projects.html
baseURL: https://api.openshift.com/apis/project.openshift.io/v1
tags:
- Multi-Tenancy
- Namespaces
- Project
tags_raw:
- Multi-Tenancy
- Namespaces
- Projects
properties:
- type: Documentation
url: https://docs.openshift.com/container-platform/latest/applications/projects/working-with-projects.html
- name: OpenShift Workloads API
description: API for managing workload resources including Pods, Deployments, DeploymentConfigs, StatefulSets, Jobs, CronJobs,
ReplicaSets, and DaemonSets.
humanURL: https://docs.redhat.com/en/documentation/openshift_container_platform/4.17/html/workloads_apis/workloads-apis
baseURL: https://api.openshift.com/apis/apps/v1
tags:
- Deployment
- Job
- Pods
- StatefulSets
- Workloads
tags_raw:
- Deployments
- Jobs
- Pods
- StatefulSets
- Workloads
properties:
- type: Documentation
url: https://docs.redhat.com/en/documentation/openshift_container_platform/4.17/html/workloads_apis/workloads-apis
- name: OpenShift Network API
description: API for managing network configuration including Services, Endpoints, Ingress, NetworkPolicy, and EgressFirewall
resources.
humanURL: https://docs.openshift.com/container-platform/4.17/rest_api/network_apis/network-apis-index.html
baseURL: https://api.openshift.com/apis/network.openshift.io/v1
tags:
- Ingress
- Networking
- Network Policy
tags_raw:
- Ingress
- Networking
- NetworkPolicy
properties:
- type: Documentation
url: https://docs.openshift.com/container-platform/4.17/rest_api/network_apis/network-apis-index.html
- name: OpenShift Storage API
description: API for managing storage resources including PersistentVolumes, PersistentVolumeClaims, StorageClasses, CSI
drivers, and VolumeSnapshots.
humanURL: https://docs.redhat.com/en/documentation/openshift_container_platform/4.17/html/storage_apis/persistentvolume-v1
baseURL: https://api.openshift.com/api/v1
tags:
- CSI
- PersistentVolumes
- Storage
- Storage Classes
tags_raw:
- CSI
- PersistentVolumes
- Storage
- StorageClasses
properties:
- type: Documentation
url: https://docs.redhat.com/en/documentation/openshift_container_platform/4.17/html/storage_apis/persistentvolume-v1
- name: OpenShift Authorization API
description: API for managing authorization resources including SubjectAccessReview, SelfSubjectAccessReview, LocalSubjectAccessReview,
and TokenReview.
humanURL: https://docs.openshift.com/container-platform/4.17/rest_api/authorization_apis/selfsubjectreview-authentication-k8s-io-v1.html
baseURL: https://api.openshift.com/apis/authorization.k8s.io/v1
tags:
- Access Control
- Authorization
- Security
properties:
- type: Documentation
url: https://docs.openshift.com/container-platform/4.17/rest_api/authorization_apis/selfsubjectreview-authentication-k8s-io-v1.html
- name: OpenShift Autoscale API
description: API for managing autoscaling resources including HorizontalPodAutoscaler, ClusterAutoscaler, and MachineAutoscaler.
humanURL: https://docs.redhat.com/en/documentation/openshift_container_platform/4.17/html/autoscale_apis/horizontalpodautoscaler-autoscaling-v2
baseURL: https://api.openshift.com/apis/autoscaling/v2
tags:
- Auto-Scaling
- ClusterAutoscaler
- HPA
tags_raw:
- Autoscaling
- ClusterAutoscaler
- HPA
properties:
- type: Documentation
url: https://docs.redhat.com/en/documentation/openshift_container_platform/4.17/html/autoscale_apis/horizontalpodautoscaler-autoscaling-v2
- name: OpenShift Config API
description: API for managing cluster configuration resources including APIServer, Authentication, Infrastructure, Ingress,
Network, OAuth, and Scheduler configuration.
humanURL: https://docs.openshift.com/container-platform/4.17/rest_api/config_apis/infrastructure-config-openshift-io-v1.html
baseURL: https://api.openshift.com/apis/config.openshift.io/v1
tags:
- Cluster Settings
- Configuration
- Infrastructure
properties:
- type: Documentation
url: https://docs.openshift.com/container-platform/4.17/rest_api/config_apis/infrastructure-config-openshift-io-v1.html
- name: OpenShift Console API
description: API for managing OpenShift web console extensions including ConsoleCLIDownload, ConsoleExternalLogLink, ConsoleLink,
ConsoleNotification, and ConsolePlugin.
humanURL: https://docs.redhat.com/en/documentation/openshift_container_platform/4.17/html-single/console_apis/index
baseURL: https://api.openshift.com/apis/console.openshift.io/v1
tags:
- Console
- Extensions
- Plugins
- Web UI
properties:
- type: Documentation
url: https://docs.redhat.com/en/documentation/openshift_container_platform/4.17/html-single/console_apis/index
- name: OpenShift Cluster API
description: API for managing cluster-level resources including ClusterVersion, ClusterOperator, and infrastructure resources.
humanURL: https://docs.redhat.com/en/documentation/openshift_container_platform/4.17/html/cluster_apis/cluster-apis
baseURL: https://api.openshift.com/apis/config.openshift.io/v1
tags:
- Cluster
- ClusterVersion
- Infrastructure
properties:
- type: Documentation
url: https://docs.redhat.com/en/documentation/openshift_container_platform/4.17/html/cluster_apis/cluster-apis
- name: OpenShift Machine API
description: API for managing machine resources including Machine, MachineSet, MachineHealthCheck, and MachineAutoscaler
for cluster node lifecycle management.
humanURL: https://docs.openshift.com/container-platform/4.9/rest_api/machine_apis/machineconfig-machineconfiguration-openshift-io-v1.html
baseURL: https://api.openshift.com/apis/machine.openshift.io/v1beta1
tags:
- Auto-Scaling
- Infrastructure
- Machines
- Node
tags_raw:
- Autoscaling
- Infrastructure
- Machines
- Nodes
properties:
- type: Documentation
url: https://docs.openshift.com/container-platform/4.9/rest_api/machine_apis/machineconfig-machineconfiguration-openshift-io-v1.html
- name: OpenShift Operator API
description: API for managing OpenShift operator lifecycle and configuration including Etcd, Console, Network, DNS, IngressController,
and other operator resources.
humanURL: https://docs.openshift.com/container-platform/4.8/rest_api/operator_apis/operator-apis-index.html
baseURL: https://api.openshift.com/apis/operator.openshift.io/v1
tags:
- Cluster Services
- Lifecycle Management
- Operator
tags_raw:
- Cluster Services
- Lifecycle Management
- Operators
properties:
- type: Documentation
url: https://docs.openshift.com/container-platform/4.8/rest_api/operator_apis/operator-apis-index.html
- name: OpenShift OperatorHub API
description: API for managing OperatorHub resources including CatalogSources, Subscriptions, InstallPlans, and ClusterServiceVersions
for the Operator Lifecycle Manager.
humanURL: https://docs.redhat.com/en/documentation/openshift_container_platform/4.17/html-single/operators/index
baseURL: https://api.openshift.com/apis/operators.coreos.com/v1alpha1
tags:
- Catalog
- OLM
- OperatorHub
- Subscription
tags_raw:
- Catalog
- OLM
- OperatorHub
- Subscriptions
properties:
- type: Documentation
url: https://docs.redhat.com/en/documentation/openshift_container_platform/4.17/html-single/operators/index
- name: OpenShift Template API
description: API for managing templates that provide parameterized sets of objects for creating applications and services.
humanURL: https://docs.openshift.com/container-platform/4.17/rest_api/template_apis/template-template-openshift-io-v1.html
baseURL: https://api.openshift.com/apis/template.openshift.io/v1
tags:
- Application Deployment
- Parameterization
- Templates
properties:
- type: Documentation
url: https://docs.openshift.com/container-platform/4.17/rest_api/template_apis/template-template-openshift-io-v1.html
- name: OpenShift Security API
description: API for managing security resources including SecurityContextConstraints, RangeAllocation, and PodSecurityPolicyReview
for controlling pod security.
humanURL: https://docs.redhat.com/en/documentation/openshift_container_platform/4.17/html/authentication_and_authorization/managing-pod-security-policies
baseURL: https://api.openshift.com/apis/security.openshift.io/v1
tags:
- Access Control
- Pod Security
- SCC
- Security
properties:
- type: Documentation
url: https://docs.redhat.com/en/documentation/openshift_container_platform/4.17/html/authentication_and_authorization/managing-pod-security-policies
- name: OpenShift RBAC API
description: API for managing role-based access control resources including Roles, ClusterRoles, RoleBindings, and ClusterRoleBindings.
humanURL: https://docs.openshift.com/container-platform/4.8/authentication/using-rbac.html
baseURL: https://api.openshift.com/apis/rbac.authorization.k8s.io/v1
tags:
- Access Control
- Authorization
- RBAC
- Roles
properties:
- type: Documentation
url: https://docs.openshift.com/container-platform/4.8/authentication/using-rbac.html
- name: OpenShift Node API
description: API for managing node-level resources including Node, RuntimeClass, and node configuration.
humanURL: https://docs.openshift.com/container-platform/4.17/rest_api/node_apis/node-apis-index.html
baseURL: https://api.openshift.com/api/v1
tags:
- Infrastructure
- Node
- Runtime
tags_raw:
- Infrastructure
- Nodes
- Runtime
properties:
- type: Documentation
url: https://docs.openshift.com/container-platform/4.17/rest_api/node_apis/node-apis-index.html
- name: OpenShift Monitoring API
description: API for managing monitoring and observability resources including Prometheus, Alertmanager, ServiceMonitor,
and PrometheusRule.
humanURL: https://docs.openshift.com/container-platform/4.17/observability/monitoring/accessing-third-party-monitoring-apis.html
baseURL: https://api.openshift.com/apis/monitoring.coreos.com/v1
tags:
- Alerting
- Monitoring
- Observability
- Prometheus
properties:
- type: Documentation
url: https://docs.openshift.com/container-platform/4.17/observability/monitoring/accessing-third-party-monitoring-apis.html
- name: OpenShift Provisioning API
description: API for managing bare metal and infrastructure provisioning resources including BareMetalHost, Provisioning,
and hardware management.
humanURL: https://docs.redhat.com/en/documentation/openshift_container_platform/4.17/html/provisioning_apis/index
baseURL: https://api.openshift.com/apis/metal3.io/v1alpha1
tags:
- Bare Metal
- Hardware
- Infrastructure
- Provisioning
properties:
- type: Documentation
url: https://docs.redhat.com/en/documentation/openshift_container_platform/4.17/html/provisioning_apis/index
- name: OpenShift Schedule and Quota API
description: API for managing scheduling and quota resources including ResourceQuota, LimitRange, PriorityClass, and ClusterResourceQuota.
humanURL: https://docs.redhat.com/en/documentation/openshift_container_platform/4.17/html/schedule_and_quota_apis/schedule-and-quota-apis
baseURL: https://api.openshift.com/api/v1
tags:
- LimitRanges
- Quotas
- Resource Management
- Scheduling
properties:
- type: Documentation
url: https://docs.redhat.com/en/documentation/openshift_container_platform/4.17/html/schedule_and_quota_apis/schedule-and-quota-apis
- name: OpenShift Metadata API
description: API for managing metadata resources including ConfigMaps, Secrets, Events, Namespaces, and ServiceAccounts.
humanURL: https://docs.openshift.com/container-platform/4.7/rest_api/metadata_apis/metadata-apis-index.html
baseURL: https://api.openshift.com/api/v1
tags:
- ConfigMaps
- Event
- Metadata
- Secrets
tags_raw:
- ConfigMaps
- Events
- Metadata
- Secrets
properties:
- type: Documentation
url: https://docs.openshift.com/container-platform/4.7/rest_api/metadata_apis/metadata-apis-index.html
- name: OpenShift Cluster Manager API
description: Managed service API for installing, modifying, operating, and upgrading Red Hat OpenShift clusters across cloud
providers.
humanURL: https://docs.redhat.com/en/documentation/openshift_cluster_manager/1-latest/html/managing_clusters/assembly-managing-clusters
baseURL: https://api.openshift.com/api/clusters_mgmt/v1
tags:
- Cluster Management
- Managed Service
- Multi-Cloud
- ROSA
properties:
- type: Documentation
url: https://docs.redhat.com/en/documentation/openshift_cluster_manager/1-latest/html/managing_clusters/assembly-managing-clusters
- type: GitHubOrganization
url: https://github.com/openshift-online/ocm-api-model
common:
- type: PostmanWorkspace
url: https://www.postman.com/kinlaneapi/red-hat-openshift/overview
- type: AgenticAccess
url: agentic-access/red-hat-openshift-agentic-access.yml
- type: VulnerabilityDisclosure
url: security/red-hat-openshift-vulnerability-disclosure.yml
- type: DomainSecurity
url: security/red-hat-openshift-domain-security.yml
- type: Authentication
url: authentication/red-hat-openshift-authentication.yml
- type: Website
url: https://www.redhat.com/en/technologies/cloud-computing/openshift
- type: Documentation
url: https://docs.openshift.com/
- type: Pricing
url: https://www.redhat.com/en/technologies/cloud-computing/openshift/pricing
- type: Blog
url: https://www.redhat.com/en/blog/channel/red-hat-openshift
- type: GitHubOrganization
url: https://github.com/openshift
- type: Signup
url: https://www.redhat.com/en/technologies/cloud-computing/openshift/try-it
- type: StatusPage
url: https://status.redhat.com/
- type: Support
url: https://access.redhat.com/support
- type: PrivacyPolicy
url: https://www.redhat.com/en/about/privacy-policy
- type: TermsOfService
url: https://www.redhat.com/en/about/agreements
- type: Training
url: https://www.redhat.com/en/services/training-and-certification
- type: OpenAPI
url: openapi/_original/red-hat-openshift-api-openapi.yml
- type: OpenAPI
url: openapi/_original/red-hat-openshift-cluster-manager-openapi.yml
- type: JSONLDContext
url: json-ld/red-hat-openshift-context.jsonld
- type: JSONSchema
url: json-schema/red-hat-openshift-project-schema.json
- type: JSONStructure
url: json-structure/red-hat-openshift-project-structure.json
- type: SpectralRuleset
url: rules/red-hat-openshift-rules.yml
- type: Vocabulary
url: vocabulary/red-hat-openshift-vocabulary.yml
maintainers:
- FN: Kin Lane
email: kin@apievangelist.com
x-parent: red-hat
x-relationship: product
x-aliases:
- OpenShift
Every provider here is available over the APIs.io API and to AI agents over MCP.