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

The MeshGateway API from Kuma — 2 operation(s) for meshgateway.

Kuma MeshGateway 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 MeshGateway. 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 8 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 8 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 MeshGateway 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.

MeshGateway 4
GET
/meshes/{mesh}/meshgateways
Returns a list of MeshGateway in the mesh.
getMeshGatewayList 4 params → 200
DELETE
/meshes/{mesh}/meshgateways/{name}
Deletes MeshGateway entity
deleteMeshGateway 2 params → 200404
GET
/meshes/{mesh}/meshgateways/{name}
Returns MeshGateway entity
getMeshGateway 2 params → 200404
PUT
/meshes/{mesh}/meshgateways/{name}
Creates or Updates MeshGateway entity
putMeshGateway 2 params body → 200201

Schemas 8

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

DataSource_File
object
1 property
NotFoundError
DataSource_Inline
object
1 property
MeshGatewayItem
object
7 properties 3 required
DataSource_Secret
object
1 property
InvalidParameters
object
5 properties 3 required
DataSource_InlineString
object
1 property
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-meshgateway-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 Meshes API
Kuma MeshExternalService API