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

Operations for managing RateLimitService custom resources that configure integration with external rate limiting services compatible with the Envoy rate limit API.

Emissary-Ingress RateLimitService 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 RateLimitService. 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 2 operations across 1 path, and defines 4 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}.

2 operations 1 paths 4 schemas 1 GET1 POST

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 2

Across 1 path, the API surfaces 2 operations — 1 GET, 1 POST. Each is listed below with its method, path, parameters, and response codes.

RateLimitService 2

Operations for managing RateLimitService custom resources that configure integration with external rate limiting services compatible with the Envoy rate limit API.

GET
/apis/getambassador.io/v3alpha1/namespaces/{namespace}/ratelimitservices
Emissary-Ingress List RateLimitService resources in a namespace
listNamespacedRateLimitService 4 params → 200401403
POST
/apis/getambassador.io/v3alpha1/namespaces/{namespace}/ratelimitservices
Emissary-Ingress Create a RateLimitService resource
createNamespacedRateLimitService 1 param body → 201400401403

Schemas 4

The contract defines 4 schemas that model the data the API accepts and returns. The most detailed are ObjectMeta (8 properties), RateLimitServiceList (4 properties), RateLimitService (4 properties), RateLimitServiceSpec (4 properties). Each schema is shown below with its type and property counts.

RateLimitServiceSpec
object
Specification for the RateLimitService.
4 properties 1 required
ObjectMeta
object
Standard Kubernetes object metadata.
8 properties 1 required
RateLimitService
object
Emissary-Ingress RateLimitService custom resource configuring integration with an external rate limiting service. The service must implement the Envoy rate lim…
4 properties 4 required
RateLimitServiceList
object
List of RateLimitService resources.
4 properties 3 required

Specification

The full machine-readable OpenAPI contract behind this narrative.

Source

emissary-ingress-ratelimitservice-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 Mapping API
Emissary-Ingress TLSContext API