Skip to main content

Fabric Adapters API

Status: INTERNAL_ONLY (BFF surface). This page describes the BFF API surface used by the dashboard. It is not a public customer contract. The backend API equivalents are WIRED_SANDBOX.

The Fabric Adapters API provides programmatic access to manage adapters in your Zen Mesh Fabric. Adapters connect your plane's delivery targets to external services.

Overview​

Fabric Adapters represent the components that handle webhook/event processing:

TypeDescription
Zen AgentPrimary webhook/event processing agent
IngesterIngests events from external sources
EgressDelivers events to external destinations
Zen LockCredential/protection layer

API Endpoints​

List Adapters for Tenant​

Retrieve all adapters for a specific tenant.

GET /api/bff/v1/tenants/{tenant_id}/adapters

Authentication: Session cookie or API key

Path Parameters:

  • tenant_id (required) - Your tenant ID

Query Parameters:

  • runtimeClass (optional) - Filter by runtime class (e.g., TENANT_CLUSTER)
  • adapterType (optional) - Filter by adapter type (e.g., INGESTER, EGRESS)

Response:

{
"adapters": [
{
"adapter_id": "adapter-123",
"tenant_id": "tenant-456",
"cluster_id": "cluster-789",
"adapter_type": "INGESTER",
"runtime_class": "TENANT_CLUSTER",
"status": "healthy",
"last_synced_at": "2026-06-29T12:00:00Z",
"source": "github",
"namespace": "default",
"created_at": "2026-06-01T00:00:00Z",
"updated_at": "2026-06-29T12:00:00Z"
}
]
}

Status Values:

  • healthy - Adapter is operational
  • error - Adapter has errors
  • unknown - Status unknown

List Adapters for Cluster​

Retrieve adapters for a specific cluster within a tenant.

GET /api/bff/v1/tenants/{tenant_id}/clusters/{cluster_id}/adapters

Response: Same structure as tenant-scoped endpoint

Disable Adapter​

Disable an adapter to stop processing.

POST /api/bff/v1/tenants/{tenant_id}/clusters/{cluster_id}/adapters/{adapter_id}/disable

Response:

{
"success": true,
"adapter_id": "adapter-123",
"status": "disabled"
}

Enable Adapter​

Re-enable a disabled adapter.

POST /api/bff/v1/tenants/{tenant_id}/clusters/{cluster_id}/adapters/{adapter_id}/enable

Response:

{
"success": true,
"adapter_id": "adapter-123",
"status": "enabled"
}

MCP Planes API​

Query operational planes for your deployment.

GET /v1/mcp/planes

Authentication: Requires mcp:read:planes scope

Response:

{
"planes": [
{"name": "control-plane", "status": "ready"},
{"name": "data-plane", "status": "ready"}
],
"service": "zen-back",
"endpoint": "mcp-planes",
"timestamp": "2026-06-29T12:00:00Z"
}

Error Responses​

Status CodeDescription
400Invalid request parameters
401Authentication required
403Insufficient permissions
404Adapter not found
500Internal server error

See Also​