How AI is applied across API Evangelist and APIs.io. Read my AI disclosure →
API Evangelist API Evangelist
Discovery
Learnings
Guidance
Toolbox
Alignment
API Evangelist LLC

Chaos Mesh Workflows API

Create and manage chaos engineering workflows with multiple steps

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.2.0, at version 1.0.

Requests are made against 2 base URLs: http://localhost:2333/api, http://{dashboardHost}:{dashboardPort}.

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.2.0
API Version
1.0
Servers
http://localhost:2333/api
http://{dashboardHost}:{dashboardPort}
Authentication
HTTP Bearer
License
Resource Areas
1

Authentication & Security 1

Chaos Mesh Workflows API declares 1 security scheme for authenticating requests. It accepts HTTP bearer tokens (bearerAuth).

  • bearerAuth — Bearer token for authenticating API requests. Typically a Kubernetes service account token with RBAC permissions to read/write Chaos Mesh custom resources in t…

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), WorkflowMeta (7 properties), WorkflowSummary (7 properties), HttpRequestForm (6 properties). Each schema is shown below with its type and property counts.

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

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
Chaos Mesh Common API
Chaos Mesh Events API
Chaos Mesh Experiments API
Chaos Mesh Schedules API
Chaos Mesh Templates API
Where this information came from

This is an independent, third-party profile of Chaos Mesh Workflows API, published by API Evangelist. We do not operate, host, resell, or support these APIs, and we are not affiliated with or endorsed by the company unless stated above. Everything here is built from publicly available information — the company's own site, developer portal, documentation, public repositories, and the specifications it publishes for public use. Nothing is obtained by breaching a system, defeating an access control, or using credentials.

The Kin Score and Agent Readiness rating are independently calculated assessments of a company's public API artifacts, scored against a published rubric. They are not certifications, endorsements, security assessments, or audits.

Corrections, re-scores, and removal are free — no partnership or purchase required, and you do not need to justify the request. A removed company is recorded as unrated, never scored zero for having asked. Acknowledgement within one business day; removal within two.

info@apievangelist.com · Read the full data-sourcing policy →
On a security or compliance team? Put security in the subject line and you will get a person, not a form — we will tell you exactly which public URLs this profile was built from.