API reference · schema

QuarantineSwarmRequest

4 fields · used by 0 operations

Last reviewed 2026-10-02

Fields

Field	Type	Meaning
`swarm_id` required	string	Target swarm fleet ID
`reason` required	string	Containment justification
`operator_id`	string or null	Operator ID default `"cain-sentinel-auto"`
`member_agents`	array of string or null	Explicit swarm member agent IDs

Smallest valid example

{
  "swarm_id": "swarm-id",
  "reason": "reason",
  "operator_id": "cain-sentinel-auto"
}

JSON Schema

Show the raw definition

{
  "properties": {
    "swarm_id": {
      "type": "string",
      "title": "Swarm Id",
      "description": "Target swarm fleet ID"
    },
    "reason": {
      "type": "string",
      "title": "Reason",
      "description": "Containment justification"
    },
    "operator_id": {
      "anyOf": [
        {
          "type": "string"
        },
        {
          "type": "null"
        }
      ],
      "title": "Operator Id",
      "description": "Operator ID",
      "default": "cain-sentinel-auto"
    },
    "member_agents": {
      "anyOf": [
        {
          "items": {
            "type": "string"
          },
          "type": "array"
        },
        {
          "type": "null"
        }
      ],
      "title": "Member Agents",
      "description": "Explicit swarm member agent IDs"
    }
  },
  "type": "object",
  "required": [
    "swarm_id",
    "reason"
  ],
  "title": "QuarantineSwarmRequest"
}

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