WAMP API

Bondy can be configured, managed and monitored via WAMP Procedures and Events. These events and procedures include the ones defined by the WAMP Meta API specification.

In Bondy, a Realm and all its entities are dynamically configured using the WAMP Admin API, these are procedures and events URIs that start with the reserved bondy. prefix e.g. bondy.user.add.

Additionally, Bondy offers WAMP Meta procedures and events (as defined by the WAMP Specification) which start with the reserved wamp. prefix e.g. wamp.session.get.

Context Diagram

The following diagram shows how the WAMP APIs described in this reference fit within the overall configuration and management landscape:

HTTP/REST API

Bondy also offers equivalent HTTP APIs for most of the entities in the WAMP API. The admin_api service serves them.

Services

The following is a catalogue of APIs organised by service. Each service provides APIs to manage (or get information about) an Entity or Feature.

Identity & Access

Realm

Creating, retrieving and managing realms and also enabling, disabling and checking per realm security status.

User

Creating, retrieving and managing users within a realm.

Group

Creating, retrieving and managing groups within a realm.

Source

Creating, retrieving and managing authentication methods and available sources within a realm.

Grant

Granting and revoking permissions over a resource for users, groups and roles.

RBAC

Check whether an identity holds a given permission on a resource.

Ticket

Issuing and revoking tickets.

OAuth2 Token

Issuing and managing the JWTs used to authenticate HTTP API Gateway requests.

OAuth2 Administration

Manage API client and resource owner identities, and revoke refresh tokens administratively.

Sessions & Routing

Session

Inspecting and managing the authenticated links between clients and the router.

Registration

Introspecting RPC registrations: paginated and WAMP Meta API listing, matching, and callee lookup.

Subscription

Introspecting Pub/Sub subscriptions: paginated and WAMP Meta API listing, matching, and subscriber lookup.

Interface Metadata & Reflection

Publishing procedure/topic/error metadata as documents, and reading it through WAMP Interface Reflection.

Clustering & Edge

Cluster

Inspecting cluster membership and node status; formation itself is configured in bondy.conf.

Bridge Relay (Edge)

Creating, retrieving and managing Bridge Relay (Edge) connections.

Gateways & Bridges

HTTP API Gateway

Load and manage API Gateway specifications.

MCP Gateway

Managing MCP overlay documents: bondy.mcp.overlay load, get, list, delete and suggested.

Mail

Sending email: send, send_async, status, relay listing and a relay test.

Health & Remediation

Alarms

Reading raised alarms cluster-wide, one alarm by id, a node history and the alarm catalogue.

Task Catalogue

The procedures sanctioned as remediations, with their impact, blast radius and dry-run support.

Node Operations

Certificate Manager

Live TLS certificate rotation, CA trust store management, and mTLS configuration.

Export & Backup

Exporting and importing Bondy's durable data (security, tokens, tickets, bridges, retained messages).

Errors

Error URIs

The catalogue of all error URIs used by Bondy and WAMP.

Utility Procedures

A small number of procedures don't belong to any single entity or feature.

bondy.ping() -> "pong"

A liveness check. It returns the string "pong" in any realm. Like every call, it needs the wamp.call permission on bondy.ping when the realm has security enabled.

Listener Procedures

These two procedures take a node out of rotation and put it back, without a restart or a configuration change. Both are master realm only: a call from any other realm fails with wamp.error.not_authorized. Neither procedure stops a listener or closes an established connection. A suspended listener stops accepting new connections, so the node drains as its sessions end.

Each procedure takes one positional argument, a listener phase:

Phase	Listeners
early	The listeners whose start_phase is early. The reserved admin listener is one of them, and it carries the liveness and readiness probes.
normal	The listeners whose start_phase is normal.
all	Both of the above.

Suspending early or all can also take down liveness and readiness. An orchestrator that probes them can then read the node as dead and kill it.

Both procedures support dry_run: true as a keyword argument. A dry run changes nothing. Its result carries dry_run (true), would, phase and listeners, the names of the listeners in the phase. No other procedure reports listener state.

bondy.listener.suspend(phase)

Stops the listeners of phase accepting new connections. The result carries no arguments. Bondy logs a notice for each call.

bondy.listener.resume(phase)

Makes the listeners of phase accept new connections again. The result carries no arguments. Bondy logs a notice for each call.

Both procedures raise wamp.error.invalid_argument when phase is not early, normal or all.

The task catalogue grades both procedures. See Network Listeners for the listener configuration.

Metrics are not part of the WAMP API

Bondy exposes its metrics over the Prometheus protocol, not over WAMP. See the Prometheus Metrics Reference for the catalogue and the /metrics endpoint.