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

Knative DomainMapping resources map a custom domain name to a Knative Service, enabling services to be served under custom hostnames with automatic TLS certificate provisioning.

Knative DomainMappings 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 DomainMappings. 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 5 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 5 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 DomainMappings 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.

DomainMappings 4

Knative DomainMapping resources map a custom domain name to a Knative Service, enabling services to be served under custom hostnames with automatic TLS certificate provisioning.

GET
/apis/serving.knative.dev/v1alpha1/namespaces/{namespace}/domainmappings
Knative List DomainMappings
listDomainMappings 4 params → 200401
POST
/apis/serving.knative.dev/v1alpha1/namespaces/{namespace}/domainmappings
Knative Create a DomainMapping
createDomainMapping 1 param body → 201400401
GET
/apis/serving.knative.dev/v1alpha1/namespaces/{namespace}/domainmappings/{name}
Knative Get a DomainMapping
getDomainMapping 2 params → 200401404
DELETE
/apis/serving.knative.dev/v1alpha1/namespaces/{namespace}/domainmappings/{name}
Knative Delete a DomainMapping
deleteDomainMapping 2 params → 200401404

Schemas 5

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

DomainMappingList
object
A list of DomainMapping resources.
4 properties 3 required
ObjectMeta
object
Standard Kubernetes object metadata.
10 properties 1 required
Condition
object
A status condition on a Knative resource.
5 properties 2 required
DomainMapping
object
A Knative DomainMapping that maps a custom domain name to a Knative Service, enabling services to be reached at custom hostnames with automatic TLS certificate…
5 properties 4 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-domainmappings-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 EventSources API
Knative EventTypes API
Knative Revisions API
Knative Routes API
Knative Subscriptions API
Knative Triggers API