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

Chaos Mesh Experiments API

Create, manage, pause, and delete chaos experiments

Chaos Mesh Experiments 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 Experiments. 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 14 operations across 9 paths, and defines 11 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.

14 operations 9 paths 11 schemas 3 DELETE5 GET2 POST4 PUT

Metadata

The identity and technical contract details declared by the specification.

Specification
OpenAPI 3.1.0
API Version
2.5
Server
http://localhost:2333/api
License
Resource Areas
1

Paths & Operations 14

Across 9 paths, the API surfaces 14 operations — 3 DELETE, 5 GET, 2 POST, 4 PUT. Each is listed below with its method, path, parameters, and response codes.

Experiments 14

Create, manage, pause, and delete chaos experiments

GET
/experiments
Chaos Mesh List chaos experiments
listExperiments 4 params → 200400500
POST
/experiments
Chaos Mesh Create a new chaos experiment
createExperiment body → 200400500
DELETE
/experiments
Chaos Mesh Batch delete chaos experiments
batchDeleteExperiments 2 params → 200400500
GET
/experiments/{uid}
Chaos Mesh Get a chaos experiment
getExperiment 1 param → 200400404500
DELETE
/experiments/{uid}
Chaos Mesh Delete a chaos experiment
deleteExperiment 2 params → 200400404500
PUT
/experiments/pause/{uid}
Chaos Mesh Pause a chaos experiment
pauseExperiment 1 param → 200400404500
PUT
/experiments/start/{uid}
Chaos Mesh Start a chaos experiment
startExperiment 1 param → 200400404500
GET
/experiments/state
Chaos Mesh Get the status of all experiments
getExperimentsState 1 param → 200400500
GET
/api/experiments
Chaos Mesh List experiments
listExperiments 4 params → 200400401500
POST
/api/experiments
Chaos Mesh Create an experiment
createExperiment body → 200400401500
GET
/api/experiments/{uid}
Chaos Mesh Get an experiment
getExperiment 1 param → 200401404500
DELETE
/api/experiments/{uid}
Chaos Mesh Delete an experiment
deleteExperiment 2 params → 200401404500
PUT
/api/experiments/{uid}/pause
Chaos Mesh Pause an experiment
pauseExperiment 1 param → 200400401404
PUT
/api/experiments/{uid}/start
Chaos Mesh Start (resume) an experiment
startExperiment 1 param → 200400401404

Schemas 11

The contract defines 11 schemas that model the data the API accepts and returns. The most detailed are ExperimentDetail_2 (8 properties), ExperimentDetail (7 properties), Experiment (6 properties), ExperimentSummary (6 properties). Each schema is shown below with its type and property counts.

ExperimentState
object
Summary count of experiments grouped by status.
5 properties
ExperimentSummary
object
Summary of a chaos experiment as returned in list operations.
6 properties
StatusResponse
object
Generic status response for operations that do not return a resource.
1 property
Experiment
object
Summary of a Chaos Mesh experiment stored in the Chaos Mesh database.
6 properties
APIError
object
Error response returned when an API request fails.
3 properties 2 required
ExperimentCreateRequest
object
Request body for creating a chaos experiment. The apiVersion, kind, metadata, and spec fields map directly to a Kubernetes custom resource manifest.
4 properties 4 required
ErrorResponse
object
Error response returned when an API operation fails.
2 properties
ExperimentDetail
object
Detailed information about a chaos experiment including its Kubernetes resource.
7 properties
KubeObjectDesc
object
A Kubernetes object description used to represent chaos custom resources. Contains the full spec of a Kubernetes resource including apiVersion, kind, metadata,…
4 properties
ExperimentDetail_2
object
Full details of a chaos experiment including spec, status, and affected resources.
8 properties
KubeObjectMeta
object
Kubernetes object metadata fields.
4 properties

Specification

The full machine-readable OpenAPI contract behind this narrative.

Source

chaos-mesh-experiments-api-openapi.yml Raw ↑

Other APIs Chaos Mesh publishes across the network.

Chaos Mesh Archives API
Chaos Mesh Common API
Chaos Mesh Events API
Chaos Mesh Schedules API
Chaos Mesh Templates API
Chaos Mesh Workflows API