Need help with your APIs? I offer API discovery, governance & evangelism services. Explore services →
API Evangelist API Evangelist
Discovery
Learnings
Guidance
Toolbox
Alignment
API Evangelist LLC

Red Hat OpenShift Routes API

Route resources for exposing services via HTTP/HTTPS hostnames

Red Hat OpenShift Routes API is one of 16 APIs that Red Hat OpenShift publishes on the APIs.io network, described by a machine-readable OpenAPI specification.

Tagged areas include Routes. The published artifact set on APIs.io includes an OpenAPI specification, API documentation, and a getting-started guide.

This API exposes 5 operations across 2 paths, and defines 4 schemas. It is described by OpenAPI 3.1.0, at version 4.0.

Requests are made against a single base URL, https://api.{cluster}:6443.

5 operations 2 paths 4 schemas 1 DELETE2 GET1 POST1 PUT

Metadata

The identity and technical contract details declared by the specification.

Specification
OpenAPI 3.1.0
API Version
4.0
Base URL
https://api.cluster.example.com:6443
Authentication
HTTP Bearer
Terms of Service
Resource Areas
1

Authentication & Security 1

Red Hat OpenShift Routes API declares 1 security scheme for authenticating requests. It accepts HTTP bearer tokens (JWT) (bearerAuth). By default, every request must be authenticated.

Paths & Operations 5

Across 2 paths, the API surfaces 5 operations — 1 DELETE, 2 GET, 1 POST, 1 PUT. Each is listed below with its method, path, parameters, and response codes.

Routes 5

Route resources for exposing services via HTTP/HTTPS hostnames

GET
/apis/route.openshift.io/v1/namespaces/{namespace}/routes
List Routes
listRoutes 3 params → 200
POST
/apis/route.openshift.io/v1/namespaces/{namespace}/routes
Create Route
createRoute 1 param body → 201
GET
/apis/route.openshift.io/v1/namespaces/{namespace}/routes/{name}
Get Route
getRoute 2 params → 200404
PUT
/apis/route.openshift.io/v1/namespaces/{namespace}/routes/{name}
Update Route
updateRoute 2 params body → 200
DELETE
/apis/route.openshift.io/v1/namespaces/{namespace}/routes/{name}
Delete Route
deleteRoute 2 params → 200404

Schemas 4

The contract defines 4 schemas that model the data the API accepts and returns. The most detailed are ObjectMeta (7 properties), Status (6 properties), Route (5 properties), RouteList (1 property). Each schema is shown below with its type and property counts.

ObjectMeta
object
7 properties
Route
object
5 properties
RouteList
object
1 property
Status
object
6 properties

Specification

The full machine-readable OpenAPI contract behind this narrative.

Source

red-hat-openshift-routes-api-openapi.yml Raw ↑

Other APIs Red Hat OpenShift publishes across the network.

Red Hat OpenShift Pipelines (Tekton) API
Red Hat OpenShift GitOps (ArgoCD) API
Red Hat OpenShift Service Mesh API
Red Hat OpenShift Serverless (Knative) API
Red Hat OpenShift Service on AWS (ROSA) API
Red Hat OpenShift Add-ons API
Red Hat OpenShift Builds API
Red Hat OpenShift Clusters API
Red Hat OpenShift Deployment Configs API
Red Hat OpenShift Identity Providers API
Red Hat OpenShift Image Streams API
Red Hat OpenShift Machine Pools API