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

Knative Routes API

Knative Route resources manage the network endpoints and traffic distribution across Revisions. Routes support percentage-based traffic splitting for canary deployments and named route targets.

Knative Routes API is one of 13 APIs that Knative publishes on the APIs.io network, described by a machine-readable OpenAPI specification and an AsyncAPI event-driven specification.

This API exposes 2 JSON Schema definitions.

Tagged areas include Routes. The published artifact set on APIs.io includes an OpenAPI specification, API documentation, an API reference, a GitHub repository, an AsyncAPI specification, and 2 JSON Schemas.

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

Requests are made against a single base URL, https://kubernetes.default.svc.

4 operations 2 paths 6 schemas 1 DELETE2 GET1 POST

Metadata

The identity and technical contract details declared by the specification.

Specification
OpenAPI 3.1.0
API Version
1.0
Server
https://kubernetes.default.svc
Authentication
HTTP Bearer
Resource Areas
1

Authentication & Security 1

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

  • bearerAuth — Kubernetes service account token or user bearer token. RBAC policies control access to Knative Eventing resources.

Paths & Operations 4

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

Routes 4

Knative Route resources manage the network endpoints and traffic distribution across Revisions. Routes support percentage-based traffic splitting for canary deployments and named…

GET
/apis/serving.knative.dev/v1/namespaces/{namespace}/routes
List Knative Routes
listRoutes 4 params → 200401
POST
/apis/serving.knative.dev/v1/namespaces/{namespace}/routes
Create a Knative Route
createRoute 1 param body → 201400401
GET
/apis/serving.knative.dev/v1/namespaces/{namespace}/routes/{name}
Get a Knative Route
getRoute 2 params → 200401404
DELETE
/apis/serving.knative.dev/v1/namespaces/{namespace}/routes/{name}
Delete a Knative Route
deleteRoute 2 params → 200401404

Schemas 6

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

TrafficTarget
object
A traffic target that routes a percentage of traffic to a specific Revision or the latest ready Revision.
6 properties
Route
object
A Knative Route that manages traffic distribution across Revisions. Routes map network endpoints to one or more Revisions and support percentage-based traffic…
5 properties 4 required
ObjectMeta
object
Standard Kubernetes object metadata.
10 properties 1 required
RouteList
object
A list of Knative Route resources.
4 properties 3 required
Condition
object
A status condition on a Knative resource.
5 properties 2 required
Status
object
Kubernetes API Status response for errors and operation results.
6 properties

Specification

The full machine-readable OpenAPI contract behind this narrative.

Source

knative-routes-api-openapi.yml Raw ↑

Other APIs Knative publishes across the network.

Knative Functions
Knative CLI (kn)
Knative Apis API
Knative Brokers API
Knative Channels API
Knative Configurations API
Knative DomainMappings API
Knative EventSources API
Knative EventTypes API
Knative Revisions API
Knative Subscriptions API
Knative Triggers API