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

Emissary-Ingress Host API

Operations for managing Host custom resources that configure domain names, TLS certificate management via ACME/Let's Encrypt, and TLS termination for ingress traffic. A Host binds a hostname to TLS configuration and controls HTTPS redirect behavior.

Emissary-Ingress Host API is one of 6 APIs that Emissary-Ingress publishes on the APIs.io network, described by a machine-readable OpenAPI specification.

This API exposes 1 JSON Schema definition.

Tagged areas include Host. The published artifact set on APIs.io includes an OpenAPI specification, API documentation, a getting-started guide, an API reference, a changelog, authentication docs, and 1 JSON Schema.

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

Requests are made against a single base URL, https://{kubernetes-api-server}.

5 operations 2 paths 8 schemas 1 DELETE2 GET1 POST1 PUT

Metadata

The identity and technical contract details declared by the specification.

Specification
OpenAPI 3.1.0
API Version
3.9.0
Server
https://{kubernetes-api-server}
License
Resource Areas
1

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.

Host 5

Operations for managing Host custom resources that configure domain names, TLS certificate management via ACME/Let's Encrypt, and TLS termination for ingress traffic. A Host binds…

GET
/apis/getambassador.io/v3alpha1/namespaces/{namespace}/hosts
Emissary-Ingress List Host resources in a namespace
listNamespacedHost 5 params → 200401403
POST
/apis/getambassador.io/v3alpha1/namespaces/{namespace}/hosts
Emissary-Ingress Create a Host resource
createNamespacedHost 1 param body → 201400401403409
GET
/apis/getambassador.io/v3alpha1/namespaces/{namespace}/hosts/{name}
Emissary-Ingress Get a specific Host resource
readNamespacedHost 2 params → 200401403404
PUT
/apis/getambassador.io/v3alpha1/namespaces/{namespace}/hosts/{name}
Emissary-Ingress Replace a Host resource
replaceNamespacedHost 2 params body → 200400401403404
DELETE
/apis/getambassador.io/v3alpha1/namespaces/{namespace}/hosts/{name}
Emissary-Ingress Delete a Host resource
deleteNamespacedHost 2 params → 200401403404

Schemas 8

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

HostSpec
object
Specification for the Host defining domain and TLS configuration.
6 properties
HostList
object
List of Host resources.
4 properties 3 required
ObjectMeta
object
Standard Kubernetes object metadata.
8 properties 1 required
Condition
object
A Kubernetes condition representing a point-in-time status observation.
5 properties 2 required
HostStatus
object
Observed status of the Host resource.
5 properties
Status
object
Standard Kubernetes Status response for error conditions.
5 properties
ACMEProvider
object
ACME (Automatic Certificate Management Environment) configuration for automatic TLS certificate provisioning via Let's Encrypt or a compatible CA.
4 properties
Host
object
Emissary-Ingress Host custom resource that configures a hostname for TLS termination, including ACME-based certificate provisioning via Let's Encrypt and TLS p…
5 properties 4 required

Specification

The full machine-readable OpenAPI contract behind this narrative.

Source

emissary-ingress-host-api-openapi.yml Raw ↑

Other APIs Emissary-Ingress publishes across the network.

Emissary-Ingress Gateway API
Emissary-Ingress AuthService API
Emissary-Ingress Mapping API
Emissary-Ingress RateLimitService API
Emissary-Ingress TLSContext API