How AI is applied across API Evangelist and APIs.io. Read my AI disclosure →
API Evangelist API Evangelist
Discovery
Learnings
Guidance
Toolbox
Alignment
API Evangelist LLC

Ambassador Mappings API

Manage Mapping resources that associate URL prefixes or paths with backend services. Mappings are the core routing mechanism in Ambassador.

Ambassador Mappings API is one of 11 APIs that Ambassador publishes on the APIs.io network, described by a machine-readable OpenAPI specification.

Tagged areas include Mappings. The published artifact set on APIs.io includes an OpenAPI specification, API documentation, a getting-started guide, and a GitHub repository.

This API exposes 5 operations across 2 paths, and defines 9 schemas. It is described by OpenAPI 3.2.0, at version 3.x.

Requests are made against 2 base URLs: https://{ambassador-host}:8877, https://{ambassador-host}/edge_stack/api.

5 operations 2 paths 9 schemas 1 DELETE2 GET1 POST1 PUT

Metadata

The identity and technical contract details declared by the specification.

Specification
OpenAPI 3.2.0
API Version
3.x
Servers
https://{ambassador-host}:8877
https://{ambassador-host}/edge_stack/api
Authentication
HTTP Bearer
License
Resource Areas
1

Authentication & Security 1

Ambassador Mappings API declares 1 security scheme for authenticating requests. It accepts HTTP bearer tokens (bearerAuth). By default, every request must be authenticated.

  • bearerAuth — Bearer token authentication. Tokens are managed through the Ambassador Edge Stack management interface or Kubernetes service account tokens.

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.

Mappings 5

Manage Mapping resources that associate URL prefixes or paths with backend services. Mappings are the core routing mechanism in Ambassador.

GET
/apis/getambassador.io/v3alpha1/namespaces/{namespace}/mappings
Ambassador List All Mappings in a Namespace
listMappings 4 params → 200401403
POST
/apis/getambassador.io/v3alpha1/namespaces/{namespace}/mappings
Ambassador Create a New Mapping
createMapping 1 param body → 201400401409
GET
/apis/getambassador.io/v3alpha1/namespaces/{namespace}/mappings/{name}
Ambassador Get a Specific Mapping
getMapping 2 params → 200401404
PUT
/apis/getambassador.io/v3alpha1/namespaces/{namespace}/mappings/{name}
Ambassador Update a Mapping
updateMapping 2 params body → 200400401404
DELETE
/apis/getambassador.io/v3alpha1/namespaces/{namespace}/mappings/{name}
Ambassador Delete a Mapping
deleteMapping 2 params → 200401404

Schemas 9

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

CircuitBreaker
object
Circuit breaker configuration for an upstream cluster
5 properties
MappingStatus
object
Status information for a Mapping resource
2 properties
MappingSpec
object
Specification for an Ambassador Mapping
32 properties 3 required
MappingList
object
List of Mapping resources
4 properties
Mapping
object
An Ambassador Mapping resource that associates a URL prefix or path with a backend service. Mappings are the primary mechanism for configuring routing in Ambas…
5 properties 4 required
RetryPolicy
object
Retry configuration for failed requests
3 properties
CORSPolicy
object
Cross-Origin Resource Sharing configuration
6 properties
LoadBalancer
object
Load balancing configuration for an upstream cluster
4 properties
ObjectMeta
object
Standard Kubernetes object metadata
8 properties 2 required

Specification

The full machine-readable OpenAPI contract behind this narrative.

Source

ambassador-mappings-api-openapi.yml Raw ↑

Other APIs Ambassador publishes across the network.

Ambassador
Emissary-Ingress
Ambassador Telepresence RESTful API
Ambassador Blackbird API Development Platform
Ambassador Edge Stack Developer Portal
Ambassador Diagnostics API
Ambassador Hosts API
Ambassador Modules API
Ambassador RateLimits API
Ambassador TLSContexts API
Where this information came from

This is an independent, third-party profile of Ambassador Mappings API, published by API Evangelist. We do not operate, host, resell, or support these APIs, and we are not affiliated with or endorsed by the company unless stated above. Everything here is built from publicly available information — the company's own site, developer portal, documentation, public repositories, and the specifications it publishes for public use. Nothing is obtained by breaching a system, defeating an access control, or using credentials.

The Kin Score and Agent Readiness rating are independently calculated assessments of a company's public API artifacts, scored against a published rubric. They are not certifications, endorsements, security assessments, or audits.

Corrections, re-scores, and removal are free — no partnership or purchase required, and you do not need to justify the request. A removed company is recorded as unrated, never scored zero for having asked. Acknowledgement within one business day; removal within two.

info@apievangelist.com · Read the full data-sourcing policy →
On a security or compliance team? Put security in the subject line and you will get a person, not a form — we will tell you exactly which public URLs this profile was built from.