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

Operations for managing Mapping custom resources that define routing rules for inbound HTTP/HTTPS traffic. A Mapping connects a URL path or prefix to a backend Kubernetes service with support for header matching, rewriting, timeouts, retries, and traffic weighting.

Emissary-Ingress Mapping 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 Mapping. 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 7 operations across 3 paths, and defines 11 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}.

7 operations 3 paths 11 schemas 1 DELETE3 GET1 PATCH1 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 7

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

Mapping 7

Operations for managing Mapping custom resources that define routing rules for inbound HTTP/HTTPS traffic. A Mapping connects a URL path or prefix to a backend Kubernetes service…

GET
/apis/getambassador.io/v3alpha1/namespaces/{namespace}/mappings
Emissary-Ingress List Mapping resources in a namespace
listNamespacedMapping 5 params → 200401403
POST
/apis/getambassador.io/v3alpha1/namespaces/{namespace}/mappings
Emissary-Ingress Create a Mapping resource
createNamespacedMapping 1 param body → 201400401403409
GET
/apis/getambassador.io/v3alpha1/namespaces/{namespace}/mappings/{name}
Emissary-Ingress Get a specific Mapping resource
readNamespacedMapping 2 params → 200401403404
PUT
/apis/getambassador.io/v3alpha1/namespaces/{namespace}/mappings/{name}
Emissary-Ingress Replace a Mapping resource
replaceNamespacedMapping 2 params body → 200400401403404409
PATCH
/apis/getambassador.io/v3alpha1/namespaces/{namespace}/mappings/{name}
Emissary-Ingress Partially update a Mapping resource
patchNamespacedMapping 2 params body → 200400401403404
DELETE
/apis/getambassador.io/v3alpha1/namespaces/{namespace}/mappings/{name}
Emissary-Ingress Delete a Mapping resource
deleteNamespacedMapping 2 params → 200401403404
GET
/apis/getambassador.io/v3alpha1/mappings
Emissary-Ingress List Mapping resources across all namespaces
listMappingAllNamespaces 4 params → 200401403

Schemas 11

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

CircuitBreaker
object
Circuit breaker configuration to prevent cascading failures.
5 properties
Mapping
object
Emissary-Ingress Mapping custom resource that defines how inbound HTTP/HTTPS requests are routed to backend Kubernetes services. A Mapping matches on a URL pre…
5 properties 4 required
ObjectMeta
object
Standard Kubernetes object metadata.
8 properties 1 required
CORSPolicy
object
Cross-Origin Resource Sharing (CORS) policy for a Mapping.
6 properties
MappingList
object
List of Mapping resources.
4 properties 3 required
MappingSpec
object
Specification for the Mapping defining routing behavior.
23 properties 2 required
Condition
object
A Kubernetes condition representing a point-in-time status observation.
5 properties 2 required
RetryPolicy
object
Retry configuration for failed upstream requests on a Mapping.
3 properties
LoadBalancer
object
Load balancing configuration for selecting between multiple instances of the upstream service.
4 properties
MappingStatus
object
Observed status of the Mapping resource as reported by Emissary-Ingress.
3 properties
Status
object
Standard Kubernetes Status response for error conditions.
5 properties

Specification

The full machine-readable OpenAPI contract behind this narrative.

Source

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

Other APIs Emissary-Ingress publishes across the network.

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