OpenShift website screenshot

OpenShift

A comprehensive API definition for Red Hat OpenShift, the enterprise Kubernetes platform.

OpenShift publishes 7 APIs on the APIs.io network, including Routes API, BuildConfigs API, Builds API, and 4 more. Tagged areas include CI/CD, Cloud Native, Containers, DevOps, and Enterprise.

The OpenShift catalog on APIs.io includes 2 JSON-LD contexts and 2 Spectral governance rulesets.

OpenShift’s developer surface includes authentication, getting-started guide, engineering blog, changelog, and 8 more developer resources.

57.7/100 strong ▬ flat Agent 31/100 agent aware Full breakdown ↓
scored 2026-07-28 · rubric v0.6
AccessFreemiumSelf serve⚡ Free to try
31 APIs 5 Features 4 Use Cases
CI/CDCloud NativeContainersDevOpsEnterpriseKubernetesPaaS

Kin Score

Kin Score Kin Score How this is scored →
scored 2026-07-28 · rubric v0.6
Composite quality — 57.7/100 · strong
Contract Quality 17.0 / 25
Developer Ergonomics 5.7 / 20
Commercial Clarity 14.7 / 20
Operational Transparency 6.8 / 13
Governance 7.0 / 12
Discoverability 6.5 / 10
Agent readiness — 31/100 · agent aware
Machine-Readable Contract 18 / 18
Agentic Access Contract 10 / 10
MCP Server 0 / 12
Machine-Readable Auth 10 / 10
Idempotency 0 / 9
Stable Error Semantics 0 / 8
Request/Response Examples 0 / 7
Rate-Limit Signaling 7 / 7
Typed Event Surface 0 / 6
Agent Skills 0 / 5
Well-Known Catalog 0 / 4
Consent & Bot Identity 0 / 3
A2A Agent Card 0 / 8
Dry-Run / Simulate Mode 0 / 4
Improve this rating by publishing the missing artifacts — every area above can be raised, and the full rubric is at apis.io/rating/. This rating is computed from github.com/api-evangelist/openshift: open an issue to ask a question, or submit a pull request to add artifacts. Want it done for you? Prioritized profiling — $2,500 →

APIs 31

Individual APIs this provider publishes, each with its own machine-readable definition.

OpenShift OAuth API

OAuth authentication and authorization API for OpenShift.

OpenShift Routes API

API for managing application routes and ingress.

OpenShift Build API

API for managing application builds and build configurations.

OpenShift Image API

API for managing container images and image streams.

OpenShift Project API

API for managing OpenShift projects (namespace extensions).

OpenShift Workloads API

API for managing workload resources including Pods, Deployments, DeploymentConfigs, StatefulSets, Jobs, CronJobs, ReplicaSets, and DaemonSets.

OpenShift Network API

API for managing network configuration including Services, Endpoints, Ingress, NetworkPolicy, and EgressFirewall resources.

OpenShift Storage API

API for managing storage resources including PersistentVolumes, PersistentVolumeClaims, StorageClasses, CSI drivers, and VolumeSnapshots.

OpenShift Authorization API

API for managing authorization resources including SubjectAccessReview, SelfSubjectAccessReview, LocalSubjectAccessReview, and TokenReview.

OpenShift Autoscale API

API for managing autoscaling resources including HorizontalPodAutoscaler, ClusterAutoscaler, and MachineAutoscaler.

OpenShift Config API

API for managing cluster configuration resources including APIServer, Authentication, Infrastructure, Ingress, Network, OAuth, and Scheduler configuration.

OpenShift Console API

API for managing OpenShift web console extensions including ConsoleCLIDownload, ConsoleExternalLogLink, ConsoleLink, ConsoleNotification, and ConsolePlugin.

OpenShift Cluster API

API for managing cluster-level resources including ClusterVersion, ClusterOperator, and infrastructure resources.

OpenShift Machine API

API for managing machine resources including Machine, MachineSet, MachineHealthCheck, and MachineAutoscaler for cluster node lifecycle management.

OpenShift Operator API

API for managing OpenShift operator lifecycle and configuration including Etcd, Console, Network, DNS, IngressController, and other operator resources.

OpenShift OperatorHub API

API for managing OperatorHub resources including CatalogSources, Subscriptions, InstallPlans, and ClusterServiceVersions for the Operator Lifecycle Manager.

OpenShift Template API

API for managing templates that provide parameterized sets of objects for creating applications and services.

OpenShift Security API

API for managing security resources including SecurityContextConstraints, RangeAllocation, and PodSecurityPolicyReview for controlling pod security.

OpenShift RBAC API

API for managing role-based access control resources including Roles, ClusterRoles, RoleBindings, and ClusterRoleBindings.

OpenShift Node API

API for managing node-level resources including Node, RuntimeClass, and node configuration.

OpenShift Monitoring API

API for managing monitoring and observability resources including Prometheus, Alertmanager, ServiceMonitor, and PrometheusRule.

OpenShift Provisioning API

API for managing bare metal and infrastructure provisioning resources including BareMetalHost, Provisioning, and hardware management.

OpenShift Schedule and Quota API

API for managing scheduling and quota resources including ResourceQuota, LimitRange, PriorityClass, and ClusterResourceQuota.

OpenShift Metadata API

API for managing metadata resources including ConfigMaps, Secrets, Events, Namespaces, and ServiceAccounts.

OpenShift Cluster Manager API

Managed service API for installing, modifying, operating, and upgrading Red Hat OpenShift clusters across cloud providers.

OpenShift BuildConfigs API

Manage build configuration templates that define how to transform source code into container images using Source, Docker, or Custom build strategies with configurable triggers.

OpenShift Builds API

Manage builds and build configurations for source-to-image, Docker, and custom build strategies. Builds compile source code into runnable container images.

OpenShift DeploymentConfigs API

Manage OpenShift DeploymentConfigs which provide declarative deployment lifecycle management with rolling, recreate, and custom strategies, plus automatic rollback and deploymen...

OpenShift ProjectRequests API

Request creation of new projects. ProjectRequests are the mechanism through which users provision new projects subject to cluster policy.

OpenShift Projects API

Manage OpenShift projects which extend Kubernetes namespaces with additional metadata, access controls, and resource isolation for multi-tenant environments.

OpenShift Routes API

Manage application routes that expose services at a hostname. Routes provide external access to services via HTTP/HTTPS, with support for TLS termination strategies including ed...

Scroll for all 31

Postman Collections 6

Ready-to-run Postman collections for exercising this provider's APIs.

Open Collections 1

Open, tool-agnostic API collections (OpenAPI-derived and Bruno).

openshift-rest-api

OPEN COLLECTION

Pricing Plans 1

Published pricing tiers and plan structures.

Rate Limits 1

Documented rate limits and quota policies.

Openshift Rate Limits

3 limits

RATE LIMITS

FinOps 1

Cost, billing, and metering signals for API financial operations.

Features 5

Notable capabilities this provider offers.

Enterprise Kubernetes

Production-grade Kubernetes platform with built-in security, monitoring, and lifecycle management.

Source-to-Image Builds

Automated container image builds directly from source code repositories.

Operator Framework

Lifecycle management for complex applications through Kubernetes Operators and OperatorHub.

Multi-Cluster Management

Centralized management of multiple OpenShift clusters across cloud providers.

Built-in Monitoring

Integrated Prometheus, Alertmanager, and Grafana for cluster and application observability.

Semantic Vocabularies 2

JSON-LD contexts and semantic vocabularies used across these APIs.

Openshift Context

0 classes · 16 properties

JSON-LD

Openshift Rest Context

0 classes · 0 properties

JSON-LD

Spectral Rules 2

Spectral governance rulesets for linting and validating these APIs.

OpenShift API Rules

6 rules · 4 warnings 2 info

SPECTRAL

OpenShift API Rules

16 rules · 8 errors 6 warnings 2 info

SPECTRAL

JSON Schema 108

Standalone JSON Schema definitions for this provider's data models.

Build

5 properties

JSON SCHEMA

BuildConfig

5 properties

JSON SCHEMA

BuildConfigList

4 properties

JSON SCHEMA

BuildConfigSpec

11 properties

JSON SCHEMA

BuildConfigStatus

2 properties

JSON SCHEMA

BuildList

4 properties

JSON SCHEMA

BuildOutput

2 properties

JSON SCHEMA

BuildRequest

5 properties

JSON SCHEMA

BuildSource

5 properties

JSON SCHEMA

BuildSpec

8 properties

JSON SCHEMA

BuildStatus

11 properties

JSON SCHEMA

BuildStrategy

4 properties

JSON SCHEMA

BuildTriggerCause

1 properties

JSON SCHEMA

BuildTriggerPolicy

4 properties

JSON SCHEMA

Container

11 properties

JSON SCHEMA

CustomBuildStrategy

4 properties

JSON SCHEMA

CustomDeploymentStrategyParams

3 properties

JSON SCHEMA

DeploymentCondition

6 properties

JSON SCHEMA

DeploymentConfig

5 properties

JSON SCHEMA

DeploymentConfigList

4 properties

JSON SCHEMA

DeploymentConfigRollback

4 properties

JSON SCHEMA

DeploymentConfigSpec

9 properties

JSON SCHEMA

DeploymentConfigStatus

8 properties

JSON SCHEMA

DeploymentStrategy

6 properties

JSON SCHEMA

DeploymentTriggerPolicy

2 properties

JSON SCHEMA

DockerBuildStrategy

6 properties

JSON SCHEMA

EnvVar

2 properties

JSON SCHEMA

ListMeta

4 properties

JSON SCHEMA

ObjectMeta

11 properties

JSON SCHEMA

ObjectReference

4 properties

JSON SCHEMA

OwnerReference

6 properties

JSON SCHEMA

PodSpec

6 properties

JSON SCHEMA

PodTemplateSpec

2 properties

JSON SCHEMA

Probe

8 properties

JSON SCHEMA

Project

5 properties

JSON SCHEMA

ProjectList

4 properties

JSON SCHEMA

ProjectRequest

5 properties

JSON SCHEMA

ProjectSpec

1 properties

JSON SCHEMA

ProjectStatus

2 properties

JSON SCHEMA

RecreateDeploymentStrategyParams

1 properties

JSON SCHEMA

ResourceRequirements

2 properties

JSON SCHEMA

BuildConfigList

3 properties

JSON SCHEMA

BuildConfig

2 properties

JSON SCHEMA

BuildConfigSpec

7 properties

JSON SCHEMA

BuildConfigStatus

2 properties

JSON SCHEMA

BuildList

3 properties

JSON SCHEMA

BuildOutput

1 properties

JSON SCHEMA

BuildRequest

4 properties

JSON SCHEMA

Build

2 properties

JSON SCHEMA

BuildSource

5 properties

JSON SCHEMA

BuildSpec

4 properties

JSON SCHEMA

BuildStatus

10 properties

JSON SCHEMA

BuildStrategy

1 properties

JSON SCHEMA

BuildTriggerCause

1 properties

JSON SCHEMA

BuildTriggerPolicy

4 properties

JSON SCHEMA

Container

8 properties

JSON SCHEMA

CustomBuildStrategy

3 properties

JSON SCHEMA

CustomDeploymentStrategyParams

3 properties

JSON SCHEMA

DeploymentCondition

6 properties

JSON SCHEMA

DeploymentConfigList

3 properties

JSON SCHEMA

DeploymentConfigRollback

4 properties

JSON SCHEMA

DeploymentConfig

2 properties

JSON SCHEMA

DeploymentConfigSpec

7 properties

JSON SCHEMA

DeploymentConfigStatus

8 properties

JSON SCHEMA

DeploymentStrategy

2 properties

JSON SCHEMA

DeploymentTriggerPolicy

2 properties

JSON SCHEMA

DockerBuildStrategy

5 properties

JSON SCHEMA

EnvVar

2 properties

JSON SCHEMA

ListMeta

4 properties

JSON SCHEMA

ObjectMeta

11 properties

JSON SCHEMA

ObjectReference

4 properties

JSON SCHEMA

OwnerReference

6 properties

JSON SCHEMA

PodSpec

6 properties

JSON SCHEMA

PodTemplateSpec

0 properties

JSON SCHEMA

Probe

8 properties

JSON SCHEMA

ProjectList

3 properties

JSON SCHEMA

ProjectRequest

4 properties

JSON SCHEMA

Project

2 properties

JSON SCHEMA

ProjectSpec

1 properties

JSON SCHEMA

ProjectStatus

2 properties

JSON SCHEMA

RecreateDeploymentStrategyParams

1 properties

JSON SCHEMA

ResourceRequirements

2 properties

JSON SCHEMA

RollingDeploymentStrategyParams

5 properties

JSON SCHEMA

RouteIngressCondition

5 properties

JSON SCHEMA

RouteIngress

4 properties

JSON SCHEMA

RouteList

3 properties

JSON SCHEMA

RoutePort

1 properties

JSON SCHEMA

Route

2 properties

JSON SCHEMA

RouteSpec

5 properties

JSON SCHEMA

RouteStatus

1 properties

JSON SCHEMA

RouteTargetReference

3 properties

JSON SCHEMA

Scale

4 properties

JSON SCHEMA

SourceBuildStrategy

4 properties

JSON SCHEMA

Status

6 properties

JSON SCHEMA

TLSConfig

6 properties

JSON SCHEMA

RollingDeploymentStrategyParams

5 properties

JSON SCHEMA

OpenShift Route

5 properties

JSON SCHEMA

RouteIngress

4 properties

JSON SCHEMA

RouteIngressCondition

5 properties

JSON SCHEMA

RouteList

4 properties

JSON SCHEMA

RoutePort

1 properties

JSON SCHEMA

RouteSpec

8 properties

JSON SCHEMA

RouteStatus

1 properties

JSON SCHEMA

RouteTargetReference

3 properties

JSON SCHEMA

Scale

5 properties

JSON SCHEMA

SourceBuildStrategy

5 properties

JSON SCHEMA

Status

7 properties

JSON SCHEMA

TLSConfig

6 properties

JSON SCHEMA

Scroll for all 108

JSON Structure 55

JSON Structure definitions describing this provider's data shapes.

Openshift Rest Build Config List Structure

3 properties

JSON STRUCTURE

Openshift Rest Build Config Spec Structure

7 properties

JSON STRUCTURE

Openshift Rest Build Config Structure

2 properties

JSON STRUCTURE

Openshift Rest Build List Structure

3 properties

JSON STRUCTURE

Openshift Rest Build Output Structure

1 properties

JSON STRUCTURE

Openshift Rest Build Request Structure

4 properties

JSON STRUCTURE

Openshift Rest Build Source Structure

5 properties

JSON STRUCTURE

Openshift Rest Build Spec Structure

4 properties

JSON STRUCTURE

Openshift Rest Build Status Structure

10 properties

JSON STRUCTURE

Openshift Rest Build Strategy Structure

1 properties

JSON STRUCTURE

Openshift Rest Build Structure

2 properties

JSON STRUCTURE

Openshift Rest Container Structure

8 properties

JSON STRUCTURE

Openshift Rest Deployment Config Structure

2 properties

JSON STRUCTURE

Openshift Rest Env Var Structure

2 properties

JSON STRUCTURE

Openshift Rest List Meta Structure

4 properties

JSON STRUCTURE

Openshift Rest Object Meta Structure

11 properties

JSON STRUCTURE

Openshift Rest Object Reference Structure

4 properties

JSON STRUCTURE

Openshift Rest Owner Reference Structure

6 properties

JSON STRUCTURE

Openshift Rest Pod Spec Structure

6 properties

JSON STRUCTURE

Openshift Rest Pod Template Spec Structure

0 properties

JSON STRUCTURE

Openshift Rest Probe Structure

8 properties

JSON STRUCTURE

Openshift Rest Project List Structure

3 properties

JSON STRUCTURE

Openshift Rest Project Request Structure

4 properties

JSON STRUCTURE

Openshift Rest Project Spec Structure

1 properties

JSON STRUCTURE

Openshift Rest Project Status Structure

2 properties

JSON STRUCTURE

Openshift Rest Project Structure

2 properties

JSON STRUCTURE

Openshift Rest Route Ingress Structure

4 properties

JSON STRUCTURE

Openshift Rest Route List Structure

3 properties

JSON STRUCTURE

Openshift Rest Route Port Structure

1 properties

JSON STRUCTURE

Openshift Rest Route Spec Structure

5 properties

JSON STRUCTURE

Openshift Rest Route Status Structure

1 properties

JSON STRUCTURE

Openshift Rest Route Structure

2 properties

JSON STRUCTURE

Openshift Rest Scale Structure

4 properties

JSON STRUCTURE

Openshift Rest Status Structure

6 properties

JSON STRUCTURE

Openshift Rest Tls Config Structure

6 properties

JSON STRUCTURE

Openshift Structure

0 properties

JSON STRUCTURE

Scroll for all 55

Examples 54

Example request and response payloads for these APIs.

Scroll for all 54

Security Posture 2

Authentication, domain security, vulnerability disclosure, and trust-center signals.

Openshift Authentication

http · 1 scheme

SECURITY

Openshift Domain Security

TLSv1.3

SECURITY

Agentic Access 1

Recommended x-agentic-access execution contracts for AI agents.

Openshift Agentic Access

42 operations · 22 acting

42 operations · 22 acting

AGENTIC

Use Cases 4

What developers build with this provider.

Application Modernization

Migrate monolithic applications to containerized microservices on Kubernetes.

CI/CD Pipelines

Automate build, test, and deployment workflows with integrated pipeline capabilities.

Edge Computing

Deploy and manage applications at edge locations with lightweight OpenShift deployments.

Hybrid Cloud Deployment

Run consistent workloads across on-premise, public cloud, and edge environments.

Integrations 3

Pre-built integrations with other platforms and tools.

Cloud Providers

Native integration with AWS (ROSA), Azure (ARO), GCP, and IBM Cloud for managed deployments.

CI/CD Tools

Integration with Jenkins, Tekton, GitLab CI, and GitHub Actions for automated pipelines.

Service Mesh

Integration with Istio-based service mesh for traffic management, security, and observability.

Resources

Get Started 2

Portal, sign-up, and the first successful call

Agent Surfaces 1

MCP servers, agent skills, and machine-readable catalogs

Build 2

SDKs, sample code, and the tooling you integrate with

Access & Security 2

Authentication, authorization, and security posture

Operate 1

Status, limits, changes, and where to get help

Commercial 2

Pricing, plans, and the legal terms of use

Company 2

The organization behind the API

Source (apis.yml)

apis.yml Raw ↑
aid: openshift
name: OpenShift
description: A comprehensive API definition for Red Hat OpenShift, the enterprise Kubernetes platform.
accessModel:
  pricing: freemium
  onboarding: self-serve
  trial: false
  try_now: true
  public: false
  label: Freemium · Self-serve signup
  confidence: high
  source:
  - plans
  - authentication
  generated: '2026-07-22'
  method: derived
image: https://kinlane-images.s3.amazonaws.com/shared/apis-json/icons/openshift.png
created: '2024-01-01'
modified: '2026-05-19'
specificationVersion: '0.18'
url: https://raw.githubusercontent.com/api-evangelist/openshift/refs/heads/main/apis.yml
type: Index
position: Consumer
access: 3rd-Party
tags:
- CI/CD
- Cloud Native
- Containers
- DevOps
- Enterprise
- Kubernetes
- PaaS
apis:
- aid: openshift:openshift-oauth-api
  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
  - OAuth
  - Security
  properties:
  - type: Documentation
    url: https://docs.openshift.com/container-platform/latest/authentication/understanding-authentication.html
- aid: openshift:openshift-routes-api
  name: OpenShift Routes API
  description: API for managing application routes and ingress.
  humanURL: https://docs.openshift.com/container-platform/latest/networking/routes/route-configuration.html
  baseURL: https://api.openshift.com/apis/route.openshift.io/v1
  tags:
  - Ingress
  - Networking
  - Routing
  properties:
  - type: Documentation
    url: https://docs.openshift.com/container-platform/latest/networking/routes/route-configuration.html
- aid: openshift:openshift-build-api
  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
- aid: openshift:openshift-image-api
  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
  - Images
  - Registry
  properties:
  - type: Documentation
    url: https://docs.openshift.com/container-platform/latest/openshift_images/index.html
- aid: openshift:openshift-project-api
  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
  - Projects
  properties:
  - type: Documentation
    url: https://docs.openshift.com/container-platform/latest/applications/projects/working-with-projects.html
- aid: openshift:openshift-workloads-api
  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:
  - 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
- aid: openshift:openshift-network-api
  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
  - NetworkPolicy
  properties:
  - type: Documentation
    url: https://docs.openshift.com/container-platform/4.17/rest_api/network_apis/network-apis-index.html
- aid: openshift:openshift-storage-api
  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
  - StorageClasses
  properties:
  - type: Documentation
    url: https://docs.redhat.com/en/documentation/openshift_container_platform/4.17/html/storage_apis/persistentvolume-v1
- aid: openshift:openshift-authorization-api
  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
- aid: openshift:openshift-autoscale-api
  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:
  - Autoscaling
  - ClusterAutoscaler
  - HPA
  properties:
  - type: Documentation
    url: https://docs.redhat.com/en/documentation/openshift_container_platform/4.17/html/autoscale_apis/horizontalpodautoscaler-autoscaling-v2
- aid: openshift:openshift-config-api
  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
- aid: openshift:openshift-console-api
  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
- aid: openshift:openshift-cluster-api
  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
- aid: openshift:openshift-machine-api
  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:
  - 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
- aid: openshift:openshift-operator-api
  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
  - Operators
  properties:
  - type: Documentation
    url: https://docs.openshift.com/container-platform/4.8/rest_api/operator_apis/operator-apis-index.html
- aid: openshift:openshift-operatorhub-api
  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
  - Subscriptions
  properties:
  - type: Documentation
    url: https://docs.redhat.com/en/documentation/openshift_container_platform/4.17/html-single/operators/index
- aid: openshift:openshift-template-api
  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
- aid: openshift:openshift-security-api
  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
- aid: openshift:openshift-rbac-api
  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
- aid: openshift:openshift-node-api
  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
  - Nodes
  - Runtime
  properties:
  - type: Documentation
    url: https://docs.openshift.com/container-platform/4.17/rest_api/node_apis/node-apis-index.html
- aid: openshift:openshift-monitoring-api
  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
- aid: openshift:openshift-provisioning-api
  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
- aid: openshift:openshift-schedule-and-quota-api
  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
- aid: openshift:openshift-metadata-api
  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
  - Events
  - Metadata
  - Secrets
  properties:
  - type: Documentation
    url: https://docs.openshift.com/container-platform/4.7/rest_api/metadata_apis/metadata-apis-index.html
- aid: openshift:openshift-cluster-manager-api
  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
- aid: openshift:openshift-buildconfigs-api
  name: OpenShift BuildConfigs API
  description: Manage build configuration templates that define how to transform source code into container images using Source,
    Docker, or Custom build strategies with configurable triggers.
  humanURL: https://docs.openshift.com/
  baseURL: https://api.openshift.com
  tags:
  - BuildConfigs
  properties:
  - type: OpenAPI
    url: openapi/openshift-buildconfigs-api-openapi.yml
  - type: Documentation
    url: https://docs.openshift.com/container-platform/latest/rest_api/index.html
  - type: Authentication
    url: https://docs.openshift.com/container-platform/latest/authentication/index.html
  - type: Pricing
    url: https://www.redhat.com/en/technologies/cloud-computing/openshift/pricing
  - type: Support
    url: https://access.redhat.com/support
  - type: StatusPage
    url: https://status.openshift.com/
  - type: SDKs
    url: https://github.com/openshift/client-go
  - type: RateLimits
    url: https://docs.openshift.com/container-platform/latest/rest_api/understanding-api-support-tiers.html
  - type: GettingStarted
    url: https://docs.redhat.com/en/documentation/openshift_container_platform/4.17/html/release_notes/index
- aid: openshift:openshift-builds-api
  name: OpenShift Builds API
  description: Manage builds and build configurations for source-to-image, Docker, and custom build strategies. Builds compile
    source code into runnable container images.
  humanURL: https://docs.openshift.com/
  baseURL: https://api.openshift.com
  tags:
  - Builds
  properties:
  - type: OpenAPI
    url: openapi/openshift-builds-api-openapi.yml
  - type: Documentation
    url: https://docs.openshift.com/container-platform/latest/rest_api/index.html
  - type: Authentication
    url: https://docs.openshift.com/container-platform/latest/authentication/index.html
  - type: Pricing
    url: https://www.redhat.com/en/technologies/cloud-computing/openshift/pricing
  - type: Support
    url: https://access.redhat.com/support
  - type: StatusPage
    url: https://status.openshift.com/
  - type: SDKs
    url: https://github.com/openshift/client-go
  - type: RateLimits
    url: https://docs.openshift.com/container-platform/latest/rest_api/understanding-api-support-tiers.html
  - type: GettingStarted
    url: https://docs.redhat.com/en/documentation/openshift_container_platform/4.17/html/release_notes/index
- aid: openshift:openshift-deploymentconfigs-api
  name: OpenShift DeploymentConfigs API
  description: Manage OpenShift DeploymentConfigs which provide declarative deployment lifecycle management with rolling,
    recreate, and custom strategies, plus automatic rollback and deployment triggers.
  humanURL: https://docs.openshift.com/
  baseURL: https://api.openshift.com
  tags:
  - DeploymentConfigs
  properties:
  - type: OpenAPI
    url: openapi/openshift-deploymentconfigs-api-openapi.yml
  - type: Documentation
    url: https://docs.openshift.com/container-platform/latest/rest_api/index.html
  - type: Authentication
    url: https://docs.openshift.com/container-platform/latest/authentication/index.html
  - type: Pricing
    url: https://www.redhat.com/en/technologies/cloud-computing/openshift/pricing
  - type: Support
    url: https://access.redhat.com/support
  - type: StatusPage
    url: https://status.openshift.com/
  - type: SDKs
    url: https://github.com/openshift/client-go
  - type: RateLimits
    url: https://docs.openshift.com/container-platform/latest/rest_api/understanding-api-support-tiers.html
  - type: GettingStarted
    url: https://docs.redhat.com/en/documentation/openshift_container_platform/4.17/html/release_notes/index
- aid: openshift:openshift-projectrequests-api
  name: OpenShift ProjectRequests API
  description: Request creation of new projects. ProjectRequests are the mechanism through which users provision new projects
    subject to cluster policy.
  humanURL: https://docs.openshift.com/
  baseURL: https://api.openshift.com
  tags:
  - ProjectRequests
  properties:
  - type: OpenAPI
    url: openapi/openshift-projectrequests-api-openapi.yml
  - type: Documentation
    url: https://docs.openshift.com/container-platform/latest/rest_api/index.html
  - type: Authentication
    url: https://docs.openshift.com/container-platform/latest/authentication/index.html
  - type: Pricing
    url: https://www.redhat.com/en/technologies/cloud-computing/openshift/pricing
  - type: Support
    url: https://access.redhat.com/support
  - type: StatusPage
    url: https://status.openshift.com/
  - type: SDKs
    url: https://github.com/openshift/client-go
  - type: RateLimits
    url: https://docs.openshift.com/container-platform/latest/rest_api/understanding-api-support-tiers.html
  - type: GettingStarted
    url: https://docs.redhat.com/en/documentation/openshift_container_platform/4.17/html/release_notes/index
- aid: openshift:openshift-projects-api
  name: OpenShift Projects API
  description: Manage OpenShift projects which extend Kubernetes namespaces with additional metadata, access controls, and
    resource isolation for multi-tenant environments.
  humanURL: https://docs.openshift.com/
  baseURL: https://api.openshift.com
  tags:
  - Projects
  properties:
  - type: OpenAPI
    url: openapi/openshift-projects-api-openapi.yml
  - type: Documentation
    url: https://docs.openshift.com/container-platform/latest/rest_api/index.html
  - type: Authentication
    url: https://docs.openshift.com/container-platform/latest/authentication/index.html
  - type: Pricing
    url: https://www.redhat.com/en/technologies/cloud-computing/openshift/pricing
  - type: Support
    url: https://access.redhat.com/support
  - type: StatusPage
    url: https://status.openshift.com/
  - type: SDKs
    url: https://github.com/openshift/client-go
  - type: RateLimits
    url: https://docs.openshift.com/container-platform/latest/rest_api/understanding-api-support-tiers.html
  - type: GettingStarted
    url: https://docs.redhat.com/en/documentation/openshift_container_platform/4.17/html/release_notes/index
- aid: openshift:openshift-routes-api
  name: OpenShift Routes API
  description: Manage application routes that expose services at a hostname. Routes provide external access to services via
    HTTP/HTTPS, with support for TLS termination strategies including edge, passthrough, and re-encrypt.
  humanURL: https://docs.openshift.com/
  baseURL: https://api.openshift.com
  tags:
  - Routes
  properties:
  - type: OpenAPI
    url: openapi/openshift-routes-api-openapi.yml
  - type: Documentation
    url: https://docs.openshift.com/container-platform/latest/rest_api/index.html
  - type: Authentication
    url: https://docs.openshift.com/container-platform/latest/authentication/index.html
  - type: Pricing
    url: https://www.redhat.com/en/technologies/cloud-computing/openshift/pricing
  - type: Support
    url: https://access.redhat.com/support
  - type: StatusPage
    url: https://status.openshift.com/
  - type: SDKs
    url: https://github.com/openshift/client-go
  - type: RateLimits
    url: https://docs.openshift.com/container-platform/latest/rest_api/understanding-api-support-tiers.html
  - type: GettingStarted
    url: https://docs.redhat.com/en/documentation/openshift_container_platform/4.17/html/release_notes/index
common:
- type: PostmanWorkspace
  url: https://www.postman.com/kinlaneapi/openshift/overview
- type: AgenticAccess
  url: agentic-access/openshift-agentic-access.yml
- type: DomainSecurity
  url: security/openshift-domain-security.yml
- type: Authentication
  url: authentication/openshift-authentication.yml
- type: LinkedIn
  url: https://www.linkedin.com/showcase/red-hat-openshift
- type: GettingStarted
  url: https://www.openshift.com/try
- type: Blog
  url: https://www.openshift.com/blog
- type: GitHubOrganization
  url: https://github.com/openshift
- type: TermsOfService
  url: https://www.redhat.com/en/about/terms-use
- type: PrivacyPolicy
  url: https://www.redhat.com/en/about/privacy-policy
- type: ChangeLog
  url: https://docs.redhat.com/en/documentation/openshift_container_platform/4.17/html/release_notes/ocp-4-17-release-notes
- type: Login
  url: https://console.redhat.com/openshift
- type: Features
  data:
  - name: Enterprise Kubernetes
    description: Production-grade Kubernetes platform with built-in security, monitoring, and lifecycle management.
  - name: Source-to-Image Builds
    description: Automated container image builds directly from source code repositories.
  - name: Operator Framework
    description: Lifecycle management for complex applications through Kubernetes Operators and OperatorHub.
  - name: Multi-Cluster Management
    description: Centralized management of multiple OpenShift clusters across cloud providers.
  - name: Built-in Monitoring
    description: Integrated Prometheus, Alertmanager, and Grafana for cluster and application observability.
- type: UseCases
  data:
  - name: Application Modernization
    description: Migrate monolithic applications to containerized microservices on Kubernetes.
  - name: CI/CD Pipelines
    description: Automate build, test, and deployment workflows with integrated pipeline capabilities.
  - name: Edge Computing
    description: Deploy and manage applications at edge locations with lightweight OpenShift deployments.
  - name: Hybrid Cloud Deployment
    description: Run consistent workloads across on-premise, public cloud, and edge environments.
- type: Integrations
  data:
  - name: Cloud Providers
    description: Native integration with AWS (ROSA), Azure (ARO), GCP, and IBM Cloud for managed deployments.
  - name: CI/CD Tools
    description: Integration with Jenkins, Tekton, GitLab CI, and GitHub Actions for automated pipelines.
  - name: Service Mesh
    description: Integration with Istio-based service mesh for traffic management, security, and observability.
maintainers:
- FN: Kin Lane
  email: kin@apievangelist.com