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

Knative Subscription resources define a delivery destination for events sent to a Channel. Each Subscription routes events from a Channel to a subscriber destination with optional reply and dead-letter handling.

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

Subscriptions 4

Knative Subscription resources define a delivery destination for events sent to a Channel. Each Subscription routes events from a Channel to a subscriber destination with optional…

GET
/apis/messaging.knative.dev/v1/namespaces/{namespace}/subscriptions
Knative List Subscriptions
listSubscriptions 4 params → 200401
POST
/apis/messaging.knative.dev/v1/namespaces/{namespace}/subscriptions
Knative Create a Subscription
createSubscription 1 param body → 201400401409
GET
/apis/messaging.knative.dev/v1/namespaces/{namespace}/subscriptions/{name}
Knative Get a Subscription
getSubscription 2 params → 200401404
DELETE
/apis/messaging.knative.dev/v1/namespaces/{namespace}/subscriptions/{name}
Knative Delete a Subscription
deleteSubscription 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), Condition (5 properties). Each schema is shown below with its type and property counts.

Subscription
object
A Knative Subscription that routes events from a Channel to a subscriber destination. Each Subscription maintains its own delivery state independently of other…
5 properties 4 required
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
ObjectMeta
object
Standard Kubernetes object metadata.
8 properties 1 required
SubscriptionList
object
A list of Subscription resources.
4 properties 3 required
Condition
object
A status condition on a Knative resource.
5 properties 2 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-subscriptions-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 Routes API
Knative Triggers API