OpenShift
A comprehensive API definition for Red Hat OpenShift, the enterprise Kubernetes platform.
Solid contracts, transparent operations, and an easy start — typically complete on four or five facets with one clear soft spot.
API Evangelist profiles OpenShift the way a machine reads it — 271 machine-readable artifacts across 31 APIs, pulled from the provider's own public surface and indexed so a developer, an analyst, or an AI agent can evaluate it against every other provider on the network.
Every provider in the network is reduced to the same set of machine-readable artifacts — OpenAPI contracts, event specifications, GraphQL schemas, runnable collections, pricing and rate-limit signals, security posture, OAuth scopes, and the agent surfaces (MCP servers and skills) that let software drive the API on its own. We profile them because the interface is the part of a company you can actually inspect: it is a truer signal of what a provider does than any marketing page. From those artifacts we compute the Kin Score — OpenShift scores 61.5/100 (strong), with a separate agent-readiness read of 48/100 (agent ready). The full breakdown is below, followed by every artifact we hold — each card links through to its machine-readable definition on apis.io.
Kin Score
This is the API Evangelist rating — a single, repeatable read computed from the artifacts on this page. Green fill is points earned; the red track is points possible, so every bar shows earned-versus-possible at a glance.
How we profile OpenShift
Each block below is one kind of artifact we hold for OpenShift. For each we say what it is and why it earns a place in the profile, then list every one we've indexed — capped at two rows, scroll within the panel for the rest.
APIs 31
Each API is captured as its own OpenAPI definition — every operation, parameter, and response. This is the single most useful machine-readable description of what an API does, and it's what lets us score, lint, mock, and generate against it without asking the provider for anything.
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 within the panel for all 31 ·
Open Collections 1
Open, tool-agnostic collections carry the same runnable value as Postman without locking you to one client — the portable, forkable form of the same exercise.
Open, tool-agnostic API collections (OpenAPI-derived and Bruno).
openshift-rest-api
OPEN COLLECTIONPricing Plans 1
Pricing is part of the interface. Machine-readable plans tell you what a tier costs and includes before you commit — one of the six things the Kin Score reads for commercial clarity.
Published pricing tiers and plan structures.
Rate Limits 1
Rate limits are the difference between a demo that works and a production integration that doesn't fall over. Publishing them is an operational-transparency signal — and a hard requirement for any agent that plans its own throughput.
Documented rate limits and quota policies.
Openshift Rate Limits
RATE LIMITSFinOps 1
Cost, billing, and metering signals let a buyer model the financial operations of an API before it's live. We profile them for the same reason we profile pricing: the money is part of the contract.
Cost, billing, and metering signals for API financial operations.
Openshift Finops
FINOPSFeatures 5
The notable capabilities this provider advertises, captured as structured features so they can be searched and compared instead of read one landing page at a time.
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 give the data shared meaning across APIs. We profile them because semantics are what let a machine reconcile 'customer' here with 'customer' somewhere else.
JSON-LD contexts and semantic vocabularies used across these APIs.
Openshift Context
JSON-LDOpenshift Rest Context
JSON-LDSpectral Rules 2
Governance rulesets we run against this provider's specs — the automated checks behind parts of the score. Profiling them makes the quality bar explicit and re-runnable, not a matter of opinion.
OpenShift API Rules
SPECTRALOpenShift API Rules
SPECTRALJSON Schema 108
Standalone JSON Schema definitions describe the data models behind the API. We profile them so the shapes are validatable on their own — useful long after a single request is forgotten.
Standalone JSON Schema definitions for this provider's data models.
Build
JSON SCHEMABuildConfig
JSON SCHEMABuildConfigList
JSON SCHEMABuildConfigSpec
JSON SCHEMABuildConfigStatus
JSON SCHEMABuildList
JSON SCHEMABuildOutput
JSON SCHEMABuildRequest
JSON SCHEMABuildSource
JSON SCHEMABuildSpec
JSON SCHEMABuildStatus
JSON SCHEMABuildStrategy
JSON SCHEMABuildTriggerCause
JSON SCHEMABuildTriggerPolicy
JSON SCHEMAContainer
JSON SCHEMACustomBuildStrategy
JSON SCHEMACustomDeploymentStrategyParams
JSON SCHEMADeploymentCondition
JSON SCHEMADeploymentConfig
JSON SCHEMADeploymentConfigList
JSON SCHEMADeploymentConfigRollback
JSON SCHEMADeploymentConfigSpec
JSON SCHEMADeploymentConfigStatus
JSON SCHEMADeploymentStrategy
JSON SCHEMADeploymentTriggerPolicy
JSON SCHEMADockerBuildStrategy
JSON SCHEMAEnvVar
JSON SCHEMAListMeta
JSON SCHEMAObjectMeta
JSON SCHEMAObjectReference
JSON SCHEMAOwnerReference
JSON SCHEMAPodSpec
JSON SCHEMAPodTemplateSpec
JSON SCHEMAProbe
JSON SCHEMAProject
JSON SCHEMAProjectList
JSON SCHEMAProjectRequest
JSON SCHEMAProjectSpec
JSON SCHEMAProjectStatus
JSON SCHEMARecreateDeploymentStrategyParams
JSON SCHEMAResourceRequirements
JSON SCHEMABuildConfigList
JSON SCHEMABuildConfig
JSON SCHEMABuildConfigSpec
JSON SCHEMABuildConfigStatus
JSON SCHEMABuildList
JSON SCHEMABuildOutput
JSON SCHEMABuildRequest
JSON SCHEMABuild
JSON SCHEMABuildSource
JSON SCHEMABuildSpec
JSON SCHEMABuildStatus
JSON SCHEMABuildStrategy
JSON SCHEMABuildTriggerCause
JSON SCHEMABuildTriggerPolicy
JSON SCHEMAContainer
JSON SCHEMACustomBuildStrategy
JSON SCHEMACustomDeploymentStrategyParams
JSON SCHEMADeploymentCondition
JSON SCHEMADeploymentConfigList
JSON SCHEMADeploymentConfigRollback
JSON SCHEMADeploymentConfig
JSON SCHEMADeploymentConfigSpec
JSON SCHEMADeploymentConfigStatus
JSON SCHEMADeploymentStrategy
JSON SCHEMADeploymentTriggerPolicy
JSON SCHEMADockerBuildStrategy
JSON SCHEMAEnvVar
JSON SCHEMAListMeta
JSON SCHEMAObjectMeta
JSON SCHEMAObjectReference
JSON SCHEMAOwnerReference
JSON SCHEMAPodSpec
JSON SCHEMAPodTemplateSpec
JSON SCHEMAProbe
JSON SCHEMAProjectList
JSON SCHEMAProjectRequest
JSON SCHEMAProject
JSON SCHEMAProjectSpec
JSON SCHEMAProjectStatus
JSON SCHEMARecreateDeploymentStrategyParams
JSON SCHEMAResourceRequirements
JSON SCHEMARollingDeploymentStrategyParams
JSON SCHEMARouteIngressCondition
JSON SCHEMARouteIngress
JSON SCHEMARouteList
JSON SCHEMARoutePort
JSON SCHEMARoute
JSON SCHEMARouteSpec
JSON SCHEMARouteStatus
JSON SCHEMARouteTargetReference
JSON SCHEMAScale
JSON SCHEMASourceBuildStrategy
JSON SCHEMAStatus
JSON SCHEMATLSConfig
JSON SCHEMARollingDeploymentStrategyParams
JSON SCHEMAOpenShift Route
JSON SCHEMARouteIngress
JSON SCHEMARouteIngressCondition
JSON SCHEMARouteList
JSON SCHEMARoutePort
JSON SCHEMARouteSpec
JSON SCHEMARouteStatus
JSON SCHEMARouteTargetReference
JSON SCHEMAScale
JSON SCHEMASourceBuildStrategy
JSON SCHEMAStatus
JSON SCHEMATLSConfig
JSON SCHEMAScroll within the panel for all 108 ·
JSON Structure 55
JSON Structure captures the data shapes in a form built for tooling — a complement to JSON Schema that keeps the model machine-legible.
JSON Structure definitions describing this provider's data shapes.
Openshift Rest Build Config List Structure
JSON STRUCTUREOpenshift Rest Build Config Spec Structure
JSON STRUCTUREOpenshift Rest Build Config Status Structure
JSON STRUCTUREOpenshift Rest Build Config Structure
JSON STRUCTUREOpenshift Rest Build List Structure
JSON STRUCTUREOpenshift Rest Build Output Structure
JSON STRUCTUREOpenshift Rest Build Request Structure
JSON STRUCTUREOpenshift Rest Build Source Structure
JSON STRUCTUREOpenshift Rest Build Spec Structure
JSON STRUCTUREOpenshift Rest Build Status Structure
JSON STRUCTUREOpenshift Rest Build Strategy Structure
JSON STRUCTUREOpenshift Rest Build Structure
JSON STRUCTUREOpenshift Rest Build Trigger Cause Structure
JSON STRUCTUREOpenshift Rest Build Trigger Policy Structure
JSON STRUCTUREOpenshift Rest Container Structure
JSON STRUCTUREOpenshift Rest Custom Build Strategy Structure
JSON STRUCTUREOpenshift Rest Deployment Condition Structure
JSON STRUCTUREOpenshift Rest Deployment Config List Structure
JSON STRUCTUREOpenshift Rest Deployment Config Rollback Structure
JSON STRUCTUREOpenshift Rest Deployment Config Spec Structure
JSON STRUCTUREOpenshift Rest Deployment Config Status Structure
JSON STRUCTUREOpenshift Rest Deployment Config Structure
JSON STRUCTUREOpenshift Rest Deployment Strategy Structure
JSON STRUCTUREOpenshift Rest Deployment Trigger Policy Structure
JSON STRUCTUREOpenshift Rest Docker Build Strategy Structure
JSON STRUCTUREOpenshift Rest Env Var Structure
JSON STRUCTUREOpenshift Rest List Meta Structure
JSON STRUCTUREOpenshift Rest Object Meta Structure
JSON STRUCTUREOpenshift Rest Object Reference Structure
JSON STRUCTUREOpenshift Rest Owner Reference Structure
JSON STRUCTUREOpenshift Rest Pod Spec Structure
JSON STRUCTUREOpenshift Rest Pod Template Spec Structure
JSON STRUCTUREOpenshift Rest Probe Structure
JSON STRUCTUREOpenshift Rest Project List Structure
JSON STRUCTUREOpenshift Rest Project Request Structure
JSON STRUCTUREOpenshift Rest Project Spec Structure
JSON STRUCTUREOpenshift Rest Project Status Structure
JSON STRUCTUREOpenshift Rest Project Structure
JSON STRUCTUREOpenshift Rest Resource Requirements Structure
JSON STRUCTUREOpenshift Rest Route Ingress Condition Structure
JSON STRUCTUREOpenshift Rest Route Ingress Structure
JSON STRUCTUREOpenshift Rest Route List Structure
JSON STRUCTUREOpenshift Rest Route Port Structure
JSON STRUCTUREOpenshift Rest Route Spec Structure
JSON STRUCTUREOpenshift Rest Route Status Structure
JSON STRUCTUREOpenshift Rest Route Structure
JSON STRUCTUREOpenshift Rest Route Target Reference Structure
JSON STRUCTUREOpenshift Rest Scale Structure
JSON STRUCTUREOpenshift Rest Source Build Strategy Structure
JSON STRUCTUREOpenshift Rest Status Structure
JSON STRUCTUREOpenshift Rest Tls Config Structure
JSON STRUCTUREOpenshift Structure
JSON STRUCTUREScroll within the panel for all 55 ·
Examples 54
Real request and response payloads are what turn a spec from abstract into obvious — and they're one of the twelve things an agent needs to call an API correctly on the first try.
Example request and response payloads for these APIs.
Openshift Rest Build Example
EXAMPLEOpenshift Rest Probe Example
EXAMPLEOpenshift Rest Route Example
EXAMPLEOpenshift Rest Scale Example
EXAMPLEScroll within the panel for all 54 ·
Security Posture 2
Authentication, domain security, vulnerability disclosure, and trust-center signals — the evidence that a provider takes security seriously enough to document it. We profile it because you can't govern what you can't see.
Authentication, domain security, vulnerability disclosure, and trust-center signals.
Agentic Access 1
An x-agentic-access contract marks which operations are safe for an agent to run on its own and which need a human in the loop. It is the difference between an API an agent can use and one it can use safely.
Recommended x-agentic-access execution contracts for AI agents.
Use Cases 4
What developers actually build with this provider — captured so the catalogue answers 'what is this for', not just 'what does this expose'.
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 tell you where this provider already fits in a stack.
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
Every other property we hold for OpenShift — documentation, portals, status pages, policies, and corporate surface — grouped by the job it does, following the integrator's arc from getting started to running in production.
Get Started 2
Portal, sign-up, and the first successful call
Agent Surfaces 1
MCP servers, agent skills, and machine-readable catalogs
Build 1
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
← All providers · Data indexed from github.com/api-evangelist/openshift · machine-readable index on apis.io