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

Kuma Meshes API

The Meshes API from Kuma — 9 operation(s) for meshes.

Kuma Meshes API is one of 38 APIs that Kuma publishes on the APIs.io network, described by a machine-readable OpenAPI specification.

This API exposes 1 JSON Schema definition.

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

This API exposes 9 operations across 9 paths, and defines 21 schemas. It is described by OpenAPI 3.1.0, at version v1alpha1.

Requests are made against the base URL https://localhost:5681.

9 operations 9 paths 21 schemas 9 GET

Metadata

The identity and technical contract details declared by the specification.

Specification
OpenAPI 3.1.0
API Version
v1alpha1
Base URL
https://localhost:5681
Authentication
HTTP Basic, HTTP Bearer
Resource Areas
1

Authentication & Security 2

Kuma Meshes API declares 2 security schemes for authenticating requests. It accepts HTTP basic authentication (BasicAuth). It accepts HTTP bearer tokens (BearerAuth). By default, every request must be authenticated, though some operations may also be called without credentials.

Paths & Operations 9

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

Meshes 9
GET
/meshes/{mesh}/dataplanes/{name}/_config
Get a proxy XDS config on a CP, this endpoint is only available on zone CPs.
get-dataplanes-xds-config 4 params → 200400500
GET
/meshes/{mesh}/dataplanes/{name}/_layout
Get networking layout for this dataplane
get-dataplanes-layout 2 params → 200400500
GET
/meshes/{mesh}/dataplanes/{name}/_policies
Get proxy policies for this dataplane
get-proxy-policy-conf 2 params → 200400500
GET
/meshes/{mesh}/dataplanes/{name}/_inbounds/{inbound-kri}/_policies
Get policies for this inbound
get-inbound-policy-conf 3 params → 200400500
GET
/meshes/{mesh}/dataplanes/{name}/_outbounds/{kri}/_policies
Get policies for this outbound
get-outbound-policy-conf 3 params → 200400500
GET
/meshes/{mesh}/dataplanes/{name}/_outbounds/{kri}/_routes
Get routes configuration for this outbound
get-outbound-routes 3 params → 200400500
GET
/meshes/{mesh}/dataplanes/{name}/_outbounds/{outbound-kri}/_routes/{route-kri}/_policies
Get policies for this route
get-route-policy-conf 4 params → 200400500
GET
/meshes/{mesh}/dataplanes/{name}/_overview
getDataplaneOverview 2 params → 200400500
GET
/meshes/{mesh}/dataplanes/_overview
getDataplaneOverviewList 1 param → 200400500

Schemas 21

The contract defines 21 schemas that model the data the API accepts and returns. The most detailed are PrometheusMetricsBackendConfig (7 properties), DataplaneNetworkingLayout (6 properties), Error (6 properties), Meta (5 properties). Each schema is shown below with its type and property counts.

Meta
object
5 properties 4 required
DataplaneInbound
object
4 properties 4 required
JsonPatchItem
object
3 properties 3 required
RouteRules
object
3 properties 3 required
RoutesList
object
1 property 1 required
DataplaneOverviewWithMeta
InboundPoliciesList
object
1 property 1 required
RouteConf
object
3 properties 3 required
PoliciesList
object
1 property 1 required
PolicyConf
object
3 properties 3 required
DataplaneNetworkingLayout
object
Dataplane networking layout. It contains the most important information about the dataplane and lists the available inbounds, outbounds, and zone proxy listene…
6 properties 5 required
InboundPolicyConf
object
3 properties 3 required
PolicyRule
object
2 properties 1 required
DataplaneOverview
object
DataplaneOverview defines the projected state of a Dataplane.
2 properties
DataplaneXDSConfig
object
2 properties 1 required
DataplaneListener
object
4 properties 4 required
PolicyOrigin
object
The list of policies KRI that contributed to the 'conf'. The order is important as it reflects in what order confs were merged to get the resulting 'conf'.
1 property 1 required
PrometheusMetricsBackendConfig
object
PrometheusMetricsBackendConfig defines configuration of Prometheus backend
7 properties
DataplaneOutbound
object
4 properties 4 required
InvalidParameters
object
5 properties 3 required
Error
object
Standard error. Follows the [AIP 193 - Errors](https://kong-aip.netlify.app/aip/193/) specification.
6 properties 5 required

Specification

The full machine-readable OpenAPI contract behind this narrative.

Source

kuma-meshes-api-openapi.yml Raw ↑

Other APIs Kuma publishes across the network.

Kuma Kubernetes Policy API
Kuma Multizone API
Kuma Dataplane API
Kuma GlobalInsight API
Kuma HostnameGenerator API
Kuma Inspect API
Kuma KRI API
Kuma Mesh API
Kuma MeshAccessLog API
Kuma MeshCircuitBreaker API
Kuma MeshExternalService API
Kuma MeshFaultInjection API