Properties
| Name | Type | Description |
|---|---|---|
| health | object | |
| message | string | Optional message providing details about the health status |
| auth_enabled | boolean | Indicates whether authentication is enabled for the cluster |
| deployment_mode | string | Runtime deployment topology |
| connectors | object | |
| index_capabilities | object | |
| secret_store | object | |
| runtime_config | object | |
| storage | object | |
| data | object |
JSON Schema
{
"$schema": "https://json-schema.org/draft/2020-12/schema",
"$id": "https://artifacts.apis.io/antfly/json-schema/antfly-cluster-topology-schema.json",
"title": "ClusterTopology",
"x-generated": "2026-11-10",
"x-method": "derived",
"x-generator": "derive-json-schema.py",
"x-source": "openapi/antfly-cluster-management-api-openapi.yml#/components/schemas/ClusterTopology",
"type": "object",
"required": [
"health",
"data"
],
"additionalProperties": true,
"properties": {
"health": {
"$ref": "#/$defs/ClusterHealth"
},
"message": {
"type": "string",
"description": "Optional message providing details about the health status"
},
"auth_enabled": {
"type": "boolean",
"description": "Indicates whether authentication is enabled for the cluster",
"x-omitzero": false
},
"deployment_mode": {
"type": "string",
"enum": [
"embedded",
"distributed",
"standalone",
"serverless"
],
"description": "Runtime deployment topology"
},
"connectors": {
"$ref": "#/$defs/ConnectorCapabilities"
},
"index_capabilities": {
"$ref": "#/$defs/IndexRuntimeCapabilities"
},
"secret_store": {
"$ref": "#/$defs/SecretStoreStatus"
},
"runtime_config": {
"$ref": "#/$defs/RuntimeConfigStatus"
},
"storage": {
"$ref": "#/$defs/StorageRuntimeStatus"
},
"data": {
"$ref": "#/$defs/ClusterDataStatus"
}
},
"$defs": {
"ArtifactSourcesCapabilityState": {
"type": "string",
"enum": [
"available",
"upgrade_pending",
"unsupported"
],
"description": "Whether artifact-backed index mutations are accepted now, temporarily fenced during a distributed rolling upgrade, or permanently unsupported by this deployment."
},
"ClusterDataGroupStatus": {
"type": "object",
"required": [
"group_id"
],
"properties": {
"group_id": {
"type": "integer",
"format": "uint64"
},
"leader_known": {
"type": "boolean"
},
"leader_data_id": {
"type": [
"integer",
"null"
],
"format": "uint64"
},
"voter_count_known": {
"type": "boolean"
},
"voter_count": {
"type": "integer",
"format": "uint32"
},
"healthy_voter_reports": {
"type": "integer",
"format": "uint32"
},
"joint_consensus": {
"type": "boolean"
},
"transition_pending": {
"type": "boolean"
},
"replay_required": {
"type": "boolean"
},
"replay_caught_up": {
"type": "boolean"
},
"cutover_ready": {
"type": "boolean"
},
"reads_ready_after_cutover": {
"type": "boolean"
},
"doc_identity_lifecycle": {
"type": "string"
},
"doc_count": {
"type": "integer",
"format": "uint64"
},
"disk_bytes": {
"type": "integer",
"format": "uint64"
},
"empty": {
"type": "boolean"
}
}
},
"ClusterDataNodeStatus": {
"type": "object",
"required": [
"data_id",
"node_id"
],
"properties": {
"data_id": {
"type": "integer",
"format": "uint64"
},
"node_id": {
"type": "integer",
"format": "uint64"
},
"api_url": {
"type": "string"
},
"raft_url": {
"type": "string"
},
"role": {
"type": "string"
},
"state": {
"type": "string"
},
"health_class": {
"type": "string"
},
"failure_domain": {
"type": "string"
},
"live": {
"type": "boolean"
},
"drain_requested": {
"type": "boolean"
},
"capacity_bytes": {
"type": "integer",
"format": "uint64"
},
"available_bytes": {
"type": "integer",
"format": "uint64"
},
"lease_pressure": {
"type": "integer",
"format": "uint32"
},
"read_load": {
"type": "integer",
"format": "uint32"
},
"write_load": {
"type": "integer",
"format": "uint32"
},
"active_backfills": {
"type": "integer",
"format": "uint32"
}
}
},
"ClusterDataRangeStatus": {
"type": "object",
"required": [
"group_id",
"range_id",
"table_id"
],
"properties": {
"group_id": {
"type": "integer",
"format": "uint64"
},
"range_id": {
"type": "integer",
"format": "uint64"
},
"table_id": {
"type": "integer",
"format": "uint64"
},
"table_name": {
"type": "string"
},
"start_key": {
"type": "string"
},
"end_key": {
"type": [
"string",
"null"
]
},
"doc_identity_shard_id": {
"type": "integer",
"format": "uint64"
},
"doc_identity_range_id": {
"type": "integer",
"format": "uint64"
},
"state": {
"type": "string"
},
"leader_data_id": {
"type": [
"integer",
"null"
],
"format": "uint64"
},
"voter_count": {
"type": "integer",
"format": "uint32"
},
"doc_count": {
"type": "integer",
"format": "uint64"
},
"disk_bytes": {
"type": "integer",
"format": "uint64"
},
"empty": {
"type": "boolean"
}
}
},
"ClusterDataReplicaStatus": {
"type": "object",
"required": [
"group_id",
"data_id",
"node_id",
"replica_id"
],
"properties": {
"group_id": {
"type": "integer",
"format": "uint64"
},
"data_id": {
"type": "integer",
"format": "uint64"
},
"node_id": {
"type": "integer",
"format": "uint64"
},
"replica_id": {
"type": "integer",
"format": "uint64"
},
"peer_node_ids": {
"type": "array",
"items": {
"type": "integer",
"format": "uint64"
}
}
}
},
"ClusterDataStatus": {
"type": "object",
"description": "Typed Zig status view for table data topology and range placement.",
"properties": {
"nodes": {
"type": "array",
"items": {
"$ref": "#/$defs/ClusterDataNodeStatus"
}
},
"ranges": {
"type": "array",
"items": {
"$ref": "#/$defs/ClusterDataRangeStatus"
}
},
"replicas": {
"type": "array",
"items": {
"$ref": "#/$defs/ClusterDataReplicaStatus"
}
},
"groups": {
"type": "array",
"items": {
"$ref": "#/$defs/ClusterDataGroupStatus"
}
}
}
},
"ClusterHealth": {
"type": "string",
"enum": [
"unknown",
"healthy",
"unhealthy",
"degraded",
"error"
],
"description": "Overall health status of the cluster"
},
"ConnectorCapabilities": {
"type": "object",
"additionalProperties": false,
"required": [
"chatgpt"
],
"description": "Effective integration availability for this deployment; independent of login providers and individual grants.",
"properties": {
"chatgpt": {
"type": "object",
"additionalProperties": false,
"required": [
"enabled"
],
"properties": {
"enabled": {
"type": "boolean",
"x-omitzero": false
},
"reason": {
"type": "string",
"enum": [
"operator_disabled",
"local_runtime_required"
]
}
}
}
}
},
"IndexRuntimeCapabilities": {
"type": "object",
"additionalProperties": false,
"required": [
"artifact_sources",
"artifact_sources_state"
],
"description": "Deployment-level index capabilities clients can inspect before submitting index mutations.",
"properties": {
"artifact_sources": {
"type": "boolean",
"description": "Whether full-text, embedding, and graph indexes may currently consume generated artifact streams through either single-source or multi-source request forms. Equivalent to artifact_sources_state=available."
},
"artifact_sources_state": {
"$ref": "#/$defs/ArtifactSourcesCapabilityState"
}
}
},
"RuntimeConfigStatus": {
"type": "object",
"description": "Non-secret status for the applied config.json snapshot. Hot publication accepts validated remote_content-only changes; startup-only changes remain stale until restart.",
"properties": {
"generation": {
"type": "integer",
"format": "uint64",
"description": "Generation of the fully validated and atomically published configuration."
},
"hash": {
"type": "string",
"description": "Lowercase SHA-256 of the exact fully applied config.json bytes; its first 16 characters match the operator config-hash annotation."
},
"last_reload_failed": {
"type": "boolean",
"description": "Whether the latest observed replacement failed loading, semantic validation, or requires restart because startup-only fields changed.",
"x-omitzero": false
},
"stale": {
"type": "boolean",
"description": "Whether requests are using the last-known-good snapshot after a failed reload.",
"x-omitzero": false
},
"reload_successes": {
"type": "integer",
"format": "uint64"
},
"reload_failures": {
"type": "integer",
"format": "uint64"
}
}
},
"SecretStoreStatus": {
"type": "object",
"description": "Non-secret status for the local secrets file store, when one is available.",
"properties": {
"generation": {
"type": "integer",
"format": "uint64",
"description": "Generation of the currently published secret-store snapshot."
},
"supports_source_generation": {
"type": "boolean",
"description": "Whether this store can expose one exact opaque source-generation acknowledgement. This remains true when a single loaded file predates the generation field, and is false for layered stores whose served snapshot has multiple publication sources.",
"x-omitzero": false
},
"source_generation": {
"type": [
"string",
"null"
],
"description": "Opaque, non-secret generation embedded by the control plane in the currently applied secrets file. It is null for files without an acknowledgement generation and never derives from secret values."
},
"last_reload_failed": {
"type": "boolean",
"description": "Whether the latest observed replacement failed to load.",
"x-omitzero": false
},
"stale": {
"type": "boolean",
"description": "Whether Antfly is serving a last-known-good secrets snapshot after a failed refresh.",
"x-omitzero": false
},
"reload_successes": {
"type": "integer",
"format": "uint64"
},
"reload_failures": {
"type": "integer",
"format": "uint64"
}
}
},
"StorageMaintenanceCapabilities": {
"type": "object",
"required": [
"check",
"compact",
"vacuum",
"online",
"asynchronous"
],
"additionalProperties": false,
"properties": {
"check": {
"type": "boolean"
},
"compact": {
"type": "boolean"
},
"vacuum": {
"type": "boolean"
},
"online": {
"type": "boolean"
},
"asynchronous": {
"type": "boolean"
}
}
},
"StorageRuntimeStatus": {
"type": "object",
"required": [
"engine",
"maintenance"
],
"additionalProperties": false,
"properties": {
"engine": {
"type": "string",
"enum": [
"lite",
"local",
"object"
]
},
"format": {
"type": "string"
},
"fsync": {
"type": "boolean"
},
"maintenance": {
"$ref": "#/$defs/StorageMaintenanceCapabilities"
}
}
}
}
}
Work with this as data
Every JSON Schema here is available over the APIs.io API and to AI agents over MCP.
MCP server
One button, every client — Claude, Cursor, VS Code and the rest.
https://apis.io/mcp
Tools for schemas
4 MCP tools reach this
find_json_schemasBrowse and filter every JSON Schema in the catalog.apis_io_searchSTART HERE — APIs, providers and tags for one query, each with its total.resolveTurn a domain, URL or GitHub org into the provider it belongs to.find_cohortsEvery scored population of providers in the catalog.
Call it yourself
curl for this page
This JSON Schema
curl "https://apis.io/api/v1/json-schemas/antfly-cluster-topology"
All schemas
curl "https://apis.io/api/v1/json-schemas?limit=25"
Calls without X-API-Key need no key. Calls with it need a paid plan — get a key.
Get an API key
Free tier, no form to fill in. Signing in shares your email address with us — we store it to create your key and to recognise you if you sign in with another provider. See our Privacy Policy and Terms.
A second provider on the same verified email joins the account you already have.