Chaos Mesh Common API is one of 7 APIs that Chaos Mesh publishes on the APIs.io network, described by a machine-readable OpenAPI specification.
This API exposes 1 JSON Schema definition.
Tagged areas include Common. The published artifact set on APIs.io includes an OpenAPI specification, API documentation, a getting-started guide, a GitHub repository, a JSON-LD context, and 1 JSON Schema.
This API exposes
11 operations
across 11 paths,
and defines 9 schemas.
It is described by OpenAPI 3.1.0, at version 2.5.
Requests are made against a single base URL, http://localhost:2333/api.
11 operations11 paths9 schemas8 GET3 POST
Metadata
The identity and technical contract details declared by the specification.
Across 11 paths, the API surfaces 11 operations — 8 GET, 3 POST. Each is listed below with its method, path, parameters, and response codes.
Common 11
Utility endpoints for cluster metadata, namespaces, and configuration
GET
/common/config
Chaos Mesh Get Dashboard configuration
getDashboardConfig→ 200500
GET
/common/namespaces
Chaos Mesh Get all Kubernetes namespaces
listNamespaces→ 200500
GET
/common/chaos-available-namespaces
Chaos Mesh Get namespaces available for chaos injection
listChaosAvailableNamespaces→ 200500
GET
/common/kinds
Chaos Mesh Get all available chaos kinds
listChaosKinds→ 200500
GET
/common/labels
Chaos Mesh Get pod labels
getPodLabels1 param→ 200400500
GET
/common/annotations
Chaos Mesh Get pod annotations
getPodAnnotations1 param→ 200400500
POST
/common/pods
Chaos Mesh List pods matching a selector
listPodsbody→ 200400500
POST
/common/physicalmachines
Chaos Mesh List physical machines matching a selector
listPhysicalMachinesbody→ 200400500
GET
/common/rbac-config
Chaos Mesh Get RBAC configuration
getRbacConfig3 params→ 200500
GET
/api/common/namespaces
Chaos Mesh List namespaces
listNamespaces→ 200401500
POST
/api/common/pods
Chaos Mesh List pods for a selector
listPodsForSelectorbody→ 200400401500
Schemas 9
The contract defines 9 schemas that model the data the API accepts and returns. The most detailed are PodInfo (5 properties), PodSelectorRequest (4 properties), DashboardConfig (4 properties), Pod (4 properties). Each schema is shown below with its type and property counts.
Pod
object
Summary of a Kubernetes pod available for chaos targeting.
4 properties
DashboardConfig
object
Configuration settings for the Chaos Mesh Dashboard.
4 properties
SelectorRequest
object
Request body for selecting pods or physical machines by label selectors.
3 properties
MapStringSliceResponse
object
A map from string keys to arrays of string values.
ErrorResponse
object
Error response returned when an API operation fails.
2 properties
PhysicalMachine
object
A physical machine or VM registered as a Chaos Mesh target.
3 properties
PodSelectorRequest
object
Request body for previewing which pods match a chaos experiment selector before creating the experiment.
4 properties2 required
APIError
object
Error response returned when an API request fails.
3 properties2 required
PodInfo
object
Information about a Kubernetes pod that could be targeted by a chaos experiment.
5 properties
Specification
The full machine-readable OpenAPI contract behind this narrative.
