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

The Inspect API from Kuma — 4 operation(s) for inspect.

Kuma Inspect 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 Inspect. 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 4 paths, and defines 20 schemas. It is described by OpenAPI 3.2.0, at version v1alpha1.

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

4 operations 4 paths 20 schemas 4 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 Inspect 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 4 paths, the API surfaces 4 operations — 4 GET. Each is listed below with its method, path, parameters, and response codes.

Inspect 4
GET
/meshes/{mesh}/{resourceType}/{resourceName}/_rules
Returns rules matching this dataplane
inspect-dataplanes-rules 3 params → 200400500
GET
/meshes/{mesh}/{policyType}/{policyName}/_resources/dataplanes
Returns resources matched by this policy
inspect-resources 6 params → 200400500
GET
/meshes/{mesh}/meshservices/{name}/_dataplanes
Returns dataplanes matched by a MeshService
inspect-meshservices-dataplanes 5 params → 200400500
GET
/meshes/{mesh}/{serviceType}/{serviceName}/_hostnames
Returns hostnames for service
inspect-hostnames 3 params → 200400404500

Schemas 20

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

InboundRulesEntry
object
2 properties 2 required
Meta
object
5 properties 4 required
ResourceRuleOrigin
object
2 properties
HttpMatch
object
2 properties 2 required
FromRule
object
2 properties 2 required
ResourceRule
object
4 properties 3 required
InboundRule
object
2 properties 2 required
InvalidParameters
object
5 properties 3 required
ProxyRule
object
a rule that affects the entire proxy
2 properties 2 required
Inbound
object
3 properties 2 required
Error
object
Standard error. Follows the [AIP 193 - Errors](https://kong-aip.netlify.app/aip/193/) specification.
6 properties 5 required
InspectHostname
object
An supported hostname along with the zones it exists in
2 properties 2 required
NotFoundError
InspectRules
object
A list of rules for a dataplane
3 properties 3 required
InspectHostnames
object
A list of hostnames
2 properties 2 required
RuleMatcher
object
A matcher to select which traffic this conf applies to
3 properties 3 required
InspectRule
object
7 properties 1 required
InspectHostnameZone
object
A name of the zone in which the hostname is available
1 property 1 required
Rule
object
3 properties 3 required
InspectDataplanesForPolicy
object
A list of proxies
3 properties 2 required

Specification

The full machine-readable OpenAPI contract behind this narrative.

Source

kuma-inspect-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 KRI 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 Inspect 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.