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

The System API from Kuma — 2 operation(s) for system.

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

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

2 operations 2 paths 6 schemas 2 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 System 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 2

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

System 2
GET
/
The index endpoint
index → 200400500
GET
/_resources
A list of all resources that exist
get-resource-type-description → 200400500

Schemas 6

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

Index
object
Some metadata about the service
7 properties 6 required
ResourceTypeDescriptionList
object
A list of all resources install
1 property 1 required
PolicyDescription
object
information about a policy
5 properties 5 required
ResourceTypeDescription
object
Description of a resource type, this is useful for dynamically generated clients and the gui
9 properties 8 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-system-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