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

The Mesh API from Kuma — 2 operation(s) for mesh.

Kuma Mesh 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 Mesh. 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 4 operations across 2 paths, and defines 15 schemas. It is described by OpenAPI 3.1.0, at version v1alpha1.

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

4 operations 2 paths 15 schemas 1 DELETE2 GET1 PUT

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 Mesh 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 4

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

Mesh 4
GET
/meshes
Returns a list of Mesh in the mesh.
getMeshList 3 params → 200
DELETE
/meshes/{name}
Deletes Mesh entity
deleteMesh 1 param → 200404
GET
/meshes/{name}
Returns Mesh entity
getMesh 1 param → 200404
PUT
/meshes/{name}
Creates or Updates Mesh entity
putMesh 1 param body → 200201

Schemas 15

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

DataSource_File
object
1 property
BuiltinCertificateAuthorityConfig
object
1 property
DataSource_InlineString
object
1 property
TcpLoggingBackendConfig
object
TcpLoggingBackendConfig defines configuration for TCP based access logs
1 property
FileLoggingBackendConfig
object
FileLoggingBackendConfig defines configuration for file based access logs
1 property
MeshItem
object
12 properties 2 required
ZipkinTracingBackendConfig
object
4 properties
NotFoundError
InvalidParameters
object
5 properties 3 required
DataSource_Secret
object
1 property
DataSource_Inline
object
1 property
DatadogTracingBackendConfig
object
3 properties
PrometheusMetricsBackendConfig
object
PrometheusMetricsBackendConfig defines configuration of Prometheus backend
7 properties
ProvidedCertificateAuthorityConfig
object
2 properties
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-mesh-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 MeshAccessLog API
Kuma MeshCircuitBreaker API
Kuma Meshes API
Kuma MeshExternalService API
Kuma MeshFaultInjection API