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 Brokers API

Knative Broker resources collect pools of events that can be consumed using Triggers. Brokers provide event routing with filtering, guaranteed delivery, and dead-letter sink support. The default broker implementation uses an in-memory channel.

Knative Brokers 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 Brokers. 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 7 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 7 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 Brokers 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.

Brokers 4

Knative Broker resources collect pools of events that can be consumed using Triggers. Brokers provide event routing with filtering, guaranteed delivery, and dead-letter sink suppo…

GET
/apis/eventing.knative.dev/v1/namespaces/{namespace}/brokers
Knative List Brokers
listBrokers 4 params → 200401
POST
/apis/eventing.knative.dev/v1/namespaces/{namespace}/brokers
Knative Create a Broker
createBroker 1 param body → 201400401409
GET
/apis/eventing.knative.dev/v1/namespaces/{namespace}/brokers/{name}
Knative Get a Broker
getBroker 2 params → 200401404
DELETE
/apis/eventing.knative.dev/v1/namespaces/{namespace}/brokers/{name}
Knative Delete a Broker
deleteBroker 2 params → 200401404

Schemas 7

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

Destination
object
A destination for delivering CloudEvents. Can reference a Kubernetes service, a Knative Service, a Broker, or a Channel via ref, or specify a direct URI.
2 properties
BrokerList
object
A list of Broker resources.
4 properties 3 required
ObjectMeta
object
Standard Kubernetes object metadata.
8 properties 1 required
Condition
object
A status condition on a Knative resource.
5 properties 2 required
Broker
object
A Knative Broker that collects a pool of events and routes them to matching Triggers. Brokers provide event filtering, guaranteed delivery, and dead-letter sin…
5 properties 3 required
Status
object
Kubernetes API Status response.
6 properties
DeliverySpec
object
Delivery configuration for event sources and Brokers.
5 properties

Specification

The full machine-readable OpenAPI contract behind this narrative.

Source

knative-brokers-api-openapi.yml Raw ↑

Other APIs Knative publishes across the network.

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