Get system info

gethttp://localhost/v1/system

Served over the Unix socket /run/chaosd/chaosd.sock

Reports the daemon version, the resolved per-direction port bindings, and the backend capabilities. Check capabilities before relying on an impairment kind.

Response

200 · application/json

System information. Returns a SystemInfo object.

versionstringRequired

Daemon version.

portslist of PortBindingRequired

Resolved binding for each direction.

capabilitiesCapabilitiesRequired

What the data-plane backend can execute. Kinds that are on the wire but unsupported are reported as false.

Errors

500

Problem

Backend or I/O error.

getGet applied impairment

get/v1/system

curl --unix-socket /run/chaosd/chaosd.sock -X GET http://localhost/v1/system

Response

{
  "version": "0.1.0",
  "ports": [
    {
      "direction": "port1",
      "interface": "enp4s0",
      "bdf": "0000:04:00.0"
    },
    {
      "direction": "port2",
      "interface": "enp5s0",
      "bdf": "0000:05:00.0"
    }
  ],
  "capabilities": {
    "supports_latency": true,
    "supports_loss_bernoulli": true,
    "supports_loss_gilbert_elliott": false,
    "supports_rate": true,
    "supports_distributions": [
      {
        "kind": "uniform"
      },
      {
        "kind": "normal"
      },
      {
        "kind": "pareto"
      }
    ],
    "backend_name": "tc-netlink",
    "backend_version": "0.1.0"
  }
}