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
Discovery
Learnings
Guidance
Toolbox
Alignment
API Evangelist LLC

Need help?

Contact us
Kin Lane

Chat with Kin

AI assistant · trained on my blog

Chaos Mesh

Chaos Mesh Workflows API

Create and manage chaos engineering workflows with multiple steps

Documentation Provider Profile APIs.io OpenAPI GitHub

Chaos Mesh Workflows 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 Workflows. 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 7 paths, and defines 15 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 7 paths 15 schemas 2 DELETE4 GET5 POST2 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
Contact
Chaos Mesh Community
License
Apache 2.0
Resource Areas
1

Paths & Operations 13

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

Workflows 13

Create and manage chaos engineering workflows with multiple steps

GET
/workflows
Chaos Mesh List workflows
listWorkflows 3 params → 200400500
POST
/workflows
Chaos Mesh Create a new workflow
createWorkflow body → 200400500
GET
/workflows/{uid}
Chaos Mesh Get workflow details
getWorkflow 1 param → 200400404500
PUT
/workflows/{uid}
Chaos Mesh Update a workflow
updateWorkflow 1 param body → 200400404500
DELETE
/workflows/{uid}
Chaos Mesh Delete a workflow
deleteWorkflow 1 param → 200400404500
POST
/workflows/parse-task/http
Chaos Mesh Parse an HTTP workflow task
parseWorkflowHttpTask body → 200400500
POST
/workflows/render-task/http
Chaos Mesh Render an HTTP workflow task
renderWorkflowHttpTask body → 200400500
POST
/workflows/validate-task/http
Chaos Mesh Validate an HTTP workflow task
validateWorkflowHttpTask body → 200400500
GET
/api/workflows
Chaos Mesh List workflows
listWorkflows 3 params → 200401500
POST
/api/workflows
Chaos Mesh Create a workflow
createWorkflow body → 200400401500
GET
/api/workflows/{uid}
Chaos Mesh Get a workflow
getWorkflow 1 param → 200401404500
PUT
/api/workflows/{uid}
Chaos Mesh Update a workflow
updateWorkflow 1 param body → 200400401404
DELETE
/api/workflows/{uid}
Chaos Mesh Delete a workflow
deleteWorkflow 1 param → 200401404

Schemas 15

The contract defines 15 schemas that model the data the API accepts and returns. The most detailed are WorkflowDetail (9 properties), WorkflowSummary (7 properties), WorkflowMeta (7 properties), Template (6 properties). Each schema is shown below with its type and property counts.

StatusResponse
object
Generic status response for operations that do not return a resource.
1 property
Topology
object
Workflow execution topology showing nodes and their states.
1 property
WorkflowMeta
object
Summary metadata for a Chaos Mesh workflow.
7 properties
APIError
object
Error response returned when an API request fails.
3 properties 2 required
ErrorResponse
object
Error response returned when an API operation fails.
2 properties
Node
object
A node in the workflow topology representing a single execution step.
6 properties
WorkflowDetail_2
object
Full details of a Chaos Mesh workflow including spec and node status.
6 properties
Template
object
A workflow template defining a single step or group in a chaos workflow.
6 properties
HttpRequestForm
object
Form representation of an HTTP workflow task for use in the UI.
6 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
WorkflowDetail
object
Detailed information about a chaos workflow including node topology.
9 properties
WorkflowSummary
object
Summary of a Chaos Mesh workflow as returned in list operations.
7 properties
ConditionalBranch
object
A conditional branch in a workflow that executes based on an expression.
2 properties
KubeObjectMeta
object
Kubernetes object metadata fields.
4 properties
WorkflowCreateRequest
object
Request body for creating or updating a Chaos Mesh workflow.
4 properties 4 required

Specification

The full machine-readable OpenAPI contract behind this narrative.

Source

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

Other APIs Chaos Mesh publishes across the network.

Chaos Mesh Archives API
AE Profile APIs.io
Chaos Mesh Common API
AE Profile APIs.io
Chaos Mesh Events API
AE Profile APIs.io
Chaos Mesh Experiments API
AE Profile APIs.io
Chaos Mesh Schedules API
AE Profile APIs.io
Chaos Mesh Templates API
AE Profile APIs.io
#Workflows
← Back to C APIs
API Details
ID
chaos-mesh:chaos-mesh-workflows-api
Server
http://localhost:2333/api
Docs
https://chaos-mesh.org/docs/
Provider
Chaos Mesh
APIs.io →  GitHub →
Explore more
All APIs Providers APIs.io Network