CAIN-42 CAIN Studio

API reference · schema

ClusterStatusResponse

17 fields · used by 0 operations

Last reviewed 2026-10-02

Fields

FieldTypeMeaning
node_id requiredstring
cluster_id requiredstring
node_count requiredinteger
healthy_nodes requiredinteger
quorum requiredinteger
is_quorum requiredboolean
can_tolerate_byzantine requiredboolean
byzantine_f1_readiness requiredstring
byzantine_f1_readiness_basisstringdefault "membership_count_only: N>=4 and >=4 trusted members. This is a topology check,
quarantined_nodes requiredarray of string
node_identity requiredobject
membership requiredobject
running requiredboolean
pbft_engine_versionstring or nulldefault "33.4-production-hardened"
pbft_viewinteger or nulldefault 0
pbft_sequenceinteger or nulldefault 0
state_rootstring or nulldefault ""

Smallest valid example

{
  "node_id": "node-id",
  "cluster_id": "cluster-id",
  "node_count": 1,
  "healthy_nodes": 1,
  "quorum": 1,
  "is_quorum": false,
  "can_tolerate_byzantine": false,
  "byzantine_f1_readiness": "byzantine-f1-readiness",
  "byzantine_f1_readiness_basis": "membership_count_only: N>=4 and >=4 trusted members. This is a topology check, not a fault-tolerance test; see the independent prober in /proof/bundle/byzantine-cluster-2026-09-21/",
  "quarantined_nodes": [
    "quarantined-nodes"
  ],
  "node_identity": {},
  "membership": {},
  "running": false,
  "pbft_engine_version": "33.4-production-hardened",
  "pbft_view": 0,
  "pbft_sequence": 0,
  "state_root": ""
}

JSON Schema

Show the raw definition
{
  "properties": {
    "node_id": {
      "type": "string",
      "title": "Node Id"
    },
    "cluster_id": {
      "type": "string",
      "title": "Cluster Id"
    },
    "node_count": {
      "type": "integer",
      "title": "Node Count"
    },
    "healthy_nodes": {
      "type": "integer",
      "title": "Healthy Nodes"
    },
    "quorum": {
      "type": "integer",
      "title": "Quorum"
    },
    "is_quorum": {
      "type": "boolean",
      "title": "Is Quorum"
    },
    "can_tolerate_byzantine": {
      "type": "boolean",
      "title": "Can Tolerate Byzantine"
    },
    "byzantine_f1_readiness": {
      "type": "string",
      "title": "Byzantine F1 Readiness"
    },
    "byzantine_f1_readiness_basis": {
      "type": "string",
      "title": "Byzantine F1 Readiness Basis",
      "default": "membership_count_only: N>=4 and >=4 trusted members. This is a topology check, not a fault-tolerance test; see the independent prober in /proof/bundle/byzantine-cluster-2026-09-21/"
    },
    "quarantined_nodes": {
      "items": {
        "type": "string"
      },
      "type": "array",
      "title": "Quarantined Nodes"
    },
    "node_identity": {
      "additionalProperties": true,
      "type": "object",
      "title": "Node Identity"
    },
    "membership": {
      "additionalProperties": true,
      "type": "object",
      "title": "Membership"
    },
    "running": {
      "type": "boolean",
      "title": "Running"
    },
    "pbft_engine_version": {
      "anyOf": [
        {
          "type": "string"
        },
        {
          "type": "null"
        }
      ],
      "title": "Pbft Engine Version",
      "default": "33.4-production-hardened"
    },
    "pbft_view": {
      "anyOf": [
        {
          "type": "integer"
        },
        {
          "type": "null"
        }
      ],
      "title": "Pbft View",
      "default": 0
    },
    "pbft_sequence": {
      "anyOf": [
        {
          "type": "integer"
        },
        {
          "type": "null"
        }
      ],
      "title": "Pbft Sequence",
      "default": 0
    },
    "state_root": {
      "anyOf": [
        {
          "type": "string"
        },
        {
          "type": "null"
        }
      ],
      "title": "State Root",
      "default": ""
    }
  },
  "type": "object",
  "required": [
    "node_id",
    "cluster_id",
    "node_count",
    "healthy_nodes",
    "quorum",
    "is_quorum",
    "can_tolerate_byzantine",
    "byzantine_f1_readiness",
    "quarantined_nodes",
    "node_identity",
    "membership",
    "running"
  ],
  "title": "ClusterStatusResponse"
}

Try CAIN-42 on your own agents

Create a free account and every new account starts with a 7-day trial of the full platform. Or try the sandbox first, with no account at all.

Create a free account →  ·  Try the sandbox  ·  See the whole ecosystem