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

Manage reusable status check templates for workflows

Chaos Mesh Templates 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 Templates. 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 5 operations across 2 paths, and defines 8 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.

5 operations 2 paths 8 schemas 1 DELETE2 GET1 POST1 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 5

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

Templates 5

Manage reusable status check templates for workflows

GET
/templates/statuschecks
Chaos Mesh List status check templates
listStatusCheckTemplates 2 params → 200400500
POST
/templates/statuschecks
Chaos Mesh Create a status check template
createStatusCheckTemplate body → 200400500
GET
/templates/statuschecks/statuscheck
Chaos Mesh Get a status check template
getStatusCheckTemplate 2 params → 200400404500
PUT
/templates/statuschecks/statuscheck
Chaos Mesh Update a status check template
updateStatusCheckTemplate body → 200400404500
DELETE
/templates/statuschecks/statuscheck
Chaos Mesh Delete a status check template
deleteStatusCheckTemplate 2 params → 200400404500

Schemas 8

The contract defines 8 schemas that model the data the API accepts and returns. The most detailed are StatusCheckSpec (6 properties), HTTPStatusCheckSpec (5 properties), StatusCheckTemplateDetail (4 properties), APIError (3 properties). Each schema is shown below with its type and property counts.

HTTPStatusCheckSpec
object
HTTP-specific configuration for a status check.
5 properties
HTTPCriteria
object
Criteria for determining a successful status check response.
1 property
StatusCheckSpec
object
Specification for a status check that polls an HTTP endpoint.
6 properties
StatusCheckTemplate
object
A status check template for use in workflow status check nodes.
3 properties
StatusCheckTemplateDetail
object
Detailed status check template with full spec.
4 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
StatusCheckTemplateBase
object
Base summary of a status check template.
3 properties

Specification

The full machine-readable OpenAPI contract behind this narrative.

Source

chaos-mesh-templates-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 Workflows API