This documentation describes the Server currently in development.
Shumoku Server API · 0.1.6-beta.4
Server API
109 operations generated from the OpenAPI contract.
Dashboards
DELETE /api/dashboards/{id} Delete a dashboard DELETE /api/dashboards/{id}/share Disable dashboard sharing GET /api/dashboards List dashboards GET /api/dashboards/{id} Get a dashboard POST /api/dashboards Create a dashboard POST /api/dashboards/{id}/share Enable dashboard sharing PUT /api/dashboards/{id} Update a dashboard Data Sources
DELETE /api/datasources/{id} Delete a data source GET /api/datasources List data sources GET /api/datasources/by-capability/{capability} List data sources by capability GET /api/datasources/{id} Get a data source GET /api/datasources/{id}/alerts Get alerts from a data source GET /api/datasources/{id}/config-options/{key} Get dynamic configuration options GET /api/datasources/{id}/connection-info Get derived connection information GET /api/datasources/{id}/filter-options Get legacy topology filter options GET /api/datasources/{id}/hosts List hosts from a data source GET /api/datasources/{id}/hosts/{hostId}/items List metric items for a host GET /api/datasources/{id}/hosts/{hostId}/metrics Discover metrics for a host GET /api/datasources/{id}/hosts/{hostId}/neighbors List interface neighbors for a host GET /api/datasources/{id}/topologies List attached topologies GET /api/datasources/types List available data source plugin types POST /api/datasources Create a data source POST /api/datasources/{id}/scan Run an ad-hoc topology scan POST /api/datasources/{id}/test Test a data source connection PUT /api/datasources/{id} Update a data source Plugins
DELETE /api/plugins/{id} Remove an external plugin GET /api/plugins List installed plugins GET /api/plugins/{id}/manifest Get an external plugin manifest PATCH /api/plugins/{id} Enable or disable an external plugin POST /api/plugins Install an external plugin POST /api/plugins/reload Reload external plugins POST /api/plugins/upload Install an external plugin from a ZIP archive Settings
Topologies
DELETE /api/topologies/{id} Delete a topology GET /api/topologies List topologies GET /api/topologies/{id} Get a topology GET /api/topologies/{id}/composition Get topology composition policy GET /api/topologies/{id}/context Get simplified topology context GET /api/topologies/{id}/display-settings Get topology display settings GET /api/topologies/{id}/export Download a rendered topology GET /api/topologies/{id}/graph Get the resolved topology graph GET /api/topologies/{id}/parsed Get parsed topology and layout GET /api/topologies/{id}/render Render a topology for embedding GET /api/topologies/{id}/resolved Get the resolved topology graph GET /api/topologies/{id}/view Get graph and server-baked layout POST /api/topologies Create a topology PUT /api/topologies/{id} Update a topology PUT /api/topologies/{id}/composition Update topology composition policy PUT /api/topologies/{id}/display-settings Update topology display settings Discovery Policy
DELETE /api/topologies/{id}/discovery-policy/exclusions Remove a node identity exclusion GET /api/topologies/{id}/discovery-policy Get effective per-node discovery policy PATCH /api/topologies/{id}/discovery-policy Update topology or node discovery policy POST /api/topologies/{id}/discovery-policy/exclusions Exclude a node identity from discovery Topology Mappings
DELETE /api/topologies/{id}/mapping/links Delete link mappings DELETE /api/topologies/{id}/mapping/nodes Delete node mappings DELETE /api/topologies/{id}/mapping/orphans/{entityId} Discard an orphaned mapping GET /api/topologies/{id}/mapping Get a topology metrics mapping GET /api/topologies/{id}/mapping/orphans List orphaned metrics mappings GET /api/topologies/{id}/mapping/sources List source-qualified metrics mappings PATCH /api/topologies/{id}/mapping/links/{linkId} Replace one link mapping PATCH /api/topologies/{id}/mapping/nodes/{nodeId} Replace one node mapping POST /api/topologies/{id}/mapping/auto-map-links Automatically map topology links POST /api/topologies/{id}/mapping/orphans/{entityId}/reassign Reassign an orphaned mapping POST /api/topologies/{id}/registry/reset Reset the topology entity registry and mappings PUT /api/topologies/{id}/mapping Replace a topology metrics mapping Topology Sharing
Topology Sources
DELETE /api/topologies/{topologyId}/sources/{sourceId} Detach a topology source GET /api/topologies/{topologyId}/sources List attached topology data sources POST /api/topologies/{topologyId}/sources Attach a data source to a topology POST /api/topologies/{topologyId}/sources/{sourceId}/clear Clear a source contribution without detaching it POST /api/topologies/{topologyId}/sources/{sourceId}/probe Deep-read selected source targets POST /api/topologies/{topologyId}/sources/{sourceId}/sync Synchronize one attached topology source PUT /api/topologies/{topologyId}/sources Replace all attached sources PUT /api/topologies/{topologyId}/sources/{sourceId} Update a topology source attachment Admin
Authentication
System
Public Shares
GET /api/share/dashboards/{token} Get a shared dashboard GET /api/share/dashboards/{token}/datasources/{id}/alerts Get alerts for a shared dashboard widget GET /api/share/dashboards/{token}/topologies/{id} Get shared dashboard topology metadata GET /api/share/dashboards/{token}/topologies/{id}/context Get shared dashboard topology context GET /api/share/dashboards/{token}/topologies/{id}/graph Get a shared dashboard topology graph GET /api/share/dashboards/{token}/topologies/{id}/metrics/stream Stream shared dashboard topology metrics GET /api/share/topologies/{token} Get shared topology context GET /api/share/topologies/{token}/graph Get shared topology graph GET /api/share/topologies/{token}/metrics/stream Stream shared topology metrics GET /api/share/topologies/{token}/render Render a shared topology GET /api/share/topologies/{token}/view Get shared topology graph and layout Topology Observations
GET /api/topologies/{id}/observations List recent topology observations GET /api/topologies/{id}/observations/{obsId} Get a topology observation GET /api/topologies/{topologyId}/sources/{sourceId}/latest-snapshot Get the latest snapshot from a topology source POST /api/topologies/{topologyId}/sources/{sourceId}/observation Record a pushed topology observation