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

Create and manage scheduled chaos experiments

Chaos Mesh Schedules 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 Schedules. 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 13 operations across 8 paths, and defines 10 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.

13 operations 8 paths 10 schemas 3 DELETE4 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 13

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

Schedules 13

Create and manage scheduled chaos experiments

GET
/schedules
Chaos Mesh List chaos schedules
listSchedules 4 params → 200400500
POST
/schedules
Chaos Mesh Create a new schedule
createSchedule body → 200400500
DELETE
/schedules
Chaos Mesh Batch delete schedules
batchDeleteSchedules 2 params → 200400500
GET
/schedules/{uid}
Chaos Mesh Get a schedule
getSchedule 1 param → 200400404500
DELETE
/schedules/{uid}
Chaos Mesh Delete a schedule
deleteSchedule 2 params → 200400404500
PUT
/schedules/pause/{uid}
Chaos Mesh Pause a schedule
pauseSchedule 1 param → 200400404500
PUT
/schedules/start/{uid}
Chaos Mesh Start a schedule
startSchedule 1 param → 200400404500
GET
/api/schedules
Chaos Mesh List schedules
listSchedules 3 params → 200401500
POST
/api/schedules
Chaos Mesh Create a schedule
createSchedule body → 200400401500
GET
/api/schedules/{uid}
Chaos Mesh Get a schedule
getSchedule 1 param → 200401404
DELETE
/api/schedules/{uid}
Chaos Mesh Delete a schedule
deleteSchedule 1 param → 200401404
PUT
/api/schedules/{uid}/pause
Chaos Mesh Pause a schedule
pauseSchedule 1 param → 200401404
PUT
/api/schedules/{uid}/start
Chaos Mesh Start (resume) a schedule
startSchedule 1 param → 200401404

Schemas 10

The contract defines 10 schemas that model the data the API accepts and returns. The most detailed are ScheduleDetail (7 properties), Schedule (6 properties), ScheduleSummary (6 properties), ScheduleDetail_2 (5 properties). Each schema is shown below with its type and property counts.

ScheduleDetail
object
Detailed information about a chaos schedule.
7 properties
Schedule
object
Summary of a Chaos Mesh schedule.
6 properties
StatusResponse
object
Generic status response for operations that do not return a resource.
1 property
APIError
object
Error response returned when an API request fails.
3 properties 2 required
ScheduleDetail_2
object
Full details of a chaos schedule including spec and experiment history.
5 properties
ErrorResponse
object
Error response returned when an API operation fails.
2 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
ScheduleSummary
object
Summary of a chaos schedule as returned in list operations.
6 properties
ScheduleCreateRequest
object
Request body for creating a chaos experiment schedule.
4 properties 4 required
KubeObjectMeta
object
Kubernetes object metadata fields.
4 properties

Specification

The full machine-readable OpenAPI contract behind this narrative.

Source

chaos-mesh-schedules-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 Experiments API
Chaos Mesh Templates API
Chaos Mesh Workflows API