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

Kuma KRI API

The KRI API from Kuma — 1 operation(s) for kri.

Kuma KRI 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 KRI. 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 1 operation across 1 path, and defines 35 schemas. It is described by OpenAPI 3.2.0, at version v1alpha1.

Requests are made against a single base URL, https://localhost:5681.

1 operations 1 paths 35 schemas 1 GET

Metadata

The identity and technical contract details declared by the specification.

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

Authentication & Security 2

Kuma KRI 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 1

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

KRI 1
GET
/_kri/{kri}
Returns a resource by KRI
getByKri 1 param → 200400404

Schemas 35

The contract defines 35 schemas that model the data the API accepts and returns. The most detailed are MeshItem (12 properties), MeshTraceItem (9 properties), MeshAccessLogItem (9 properties), MeshMetricItem (9 properties). Each schema is shown below with its type and property counts.

MeshProxyPatchItem
object
MeshProxyPatch provides advanced customization of the Envoy proxy configuration generated by Kuma. It allows you to add, remove, or modify Envoy resources (clu…
8 properties 3 required
ZipkinTracingBackendConfig
object
4 properties
FileLoggingBackendConfig
object
FileLoggingBackendConfig defines configuration for file based access logs
1 property
TcpLoggingBackendConfig
object
TcpLoggingBackendConfig defines configuration for TCP based access logs
1 property
DataSource_Secret
object
1 property
MeshGatewayItem
object
7 properties 3 required
MeshHTTPRouteItem
object
NOTICE: This policy defines its own GetDefault method so that it can have the given structure for deserialization but still use the generic policy merging mach…
8 properties 3 required
ProvidedCertificateAuthorityConfig
object
2 properties
ZoneIngressItem
object
6 properties 2 required
DatadogTracingBackendConfig
object
3 properties
DataSource_File
object
1 property
MeshRateLimitItem
object
MeshRateLimit protects services from being overwhelmed by limiting the rate of incoming requests or connections. It supports local rate limiting for both HTTP…
8 properties 3 required
InvalidParameters
object
5 properties 3 required
MeshTrafficPermissionItem
object
MeshTrafficPermission controls which services are allowed to communicate with each other in the mesh. It provides fine-grained access control by allowing you t…
8 properties 3 required
MeshTLSItem
object
MeshTLS configures TLS and mutual TLS (mTLS) settings for secure communication between services in the mesh. It allows you to enforce encryption, configure TLS…
8 properties 3 required
MeshTraceItem
object
MeshTrace enables distributed tracing to track requests as they flow through multiple services in the mesh. It supports exporting trace data to backends like Z…
9 properties 3 required
MeshCircuitBreakerItem
object
MeshCircuitBreaker protects services from cascading failures by limiting connections and detecting unhealthy instances. It provides connection limits to preven…
8 properties 3 required
MeshMetricItem
object
MeshMetric enables collection and export of service mesh metrics. It configures sidecar and application metrics scraping, allows customization of which metrics…
9 properties 3 required
Error
object
Standard error. Follows the [AIP 193 - Errors](https://kong-aip.netlify.app/aip/193/) specification.
6 properties 5 required
MeshTimeoutItem
object
MeshTimeout configures timeout limits for service-to-service communication to prevent requests from hanging indefinitely. It supports connection timeouts, idle…
8 properties 3 required
NotFoundError
MeshTCPRouteItem
object
NOTICE: This policy defines its own GetDefault method so that it can have the given structure for deserialization but still use the generic policy merging mach…
8 properties 3 required
MeshRetryItem
object
MeshRetry configures automatic retry behavior for failed requests to improve service reliability. It supports configurable retry conditions, limits, timeouts,…
8 properties 3 required
BuiltinCertificateAuthorityConfig
object
1 property
MeshItem
object
12 properties 2 required
MeshAccessLogItem
object
MeshAccessLog configures access logging for traffic between services in the mesh. It allows you to capture and export request/response logs to various backends…
9 properties 3 required
DataSource_InlineString
object
1 property
MeshPassthroughItem
object
MeshPassthrough controls how traffic to external services (outside the mesh) is handled by the sidecar proxy. It allows you to configure passthrough mode to pe…
8 properties 3 required
PrometheusMetricsBackendConfig
object
PrometheusMetricsBackendConfig defines configuration of Prometheus backend
7 properties
DataplaneItem
object
7 properties 3 required
MeshLoadBalancingStrategyItem
object
MeshLoadBalancingStrategy configures how traffic is distributed across service instances. It supports multiple load balancing algorithms (round-robin, least re…
8 properties 3 required
ZoneEgressItem
object
5 properties 2 required
MeshFaultInjectionItem
object
MeshFaultInjection allows you to test the resiliency of your services by injecting faults like delays, connection aborts, and response bandwidth limits into th…
8 properties 3 required
MeshHealthCheckItem
object
MeshHealthCheck enables active health checking of services in the mesh. It periodically probes service endpoints using TCP, HTTP, or gRPC health checks to dete…
8 properties 3 required
DataSource_Inline
object
1 property

Specification

The full machine-readable OpenAPI contract behind this narrative.

Source

kuma-kri-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 Mesh API
Kuma MeshAccessLog API
Kuma MeshCircuitBreaker API
Kuma Meshes API
Kuma MeshExternalService API
Kuma MeshFaultInjection API
Where this information came from

This is an independent, third-party profile of Kuma KRI 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.