API routes
The routes this build serves, read from the running app's route map and view docstrings.
Browser session API
Protected routes use the same signed browser session as the HTML app. Writes require an administrator, JSON body, and X-CSRF-Token. The health route is public. This page lists the current code contract rather than private inventory data.
| Method | Path | Purpose | Access |
|---|---|---|---|
| GET | /api/v1/clients |
Return cached endpoint nodes, permission hints, and known subnet provenance. | Signed-in |
| POST | /api/v1/clients/<int:observation_id>/inventory |
Explicitly add a client observation to inventory without requiring placement. | Admin + CSRF |
| POST | /api/v1/clients/<int:observation_id>/scan |
Check a fixed common TCP port set on one fresh, explicitly permitted client. | Admin + CSRF |
| GET | /api/v1/cluster |
Return every Proxmox source's nodes, guests, networks, and storage. | Signed-in |
| POST | /api/v1/containers/<int:container_id> |
Rename a shelf, surface, area, wall, floor, ceiling, or shared shelf. | Admin + CSRF |
| POST | /api/v1/containers/<int:container_id>/delete |
Delete a shelf, surface, area, or shared rack shelf and what sits on it. | Admin + CSRF |
| POST | /api/v1/containers/<int:container_id>/layout |
Save a container's dimensionless position in its room or parent surface. | Admin + CSRF |
| GET | /api/v1/health |
Report Flask API liveness without probing collectors or storage. | Public |
| GET | /api/v1/locations |
List selectable inventory locations and existing canonical devices. | Signed-in |
| POST | /api/v1/locations |
Create a site, room, rack, or non-rack mounting surface. | Admin + CSRF |
| GET | /api/v1/me |
Return the current user's safe profile fields as JSON. | Signed-in |
| POST | /api/v1/neighbor-matches |
Save an explicit neighbor-to-server-NIC identity and refresh cached cables. | Admin + CSRF |
| POST | /api/v1/neighbor-matches/<int:match_id>/remove |
Remove an operator identity match and recompute its observed cables. | Admin + CSRF |
| GET | /api/v1/network |
Return each UniFi source's network snapshot with derived zone paths. | Signed-in |
| GET | /api/v1/observation-ignores |
List shared observation ignore rules, including currently clear conditions. | Signed-in |
| POST | /api/v1/observation-ignores |
Ignore one exact cached condition with administrator auth, CSRF, and audit. | Admin + CSRF |
| POST | /api/v1/observation-ignores/<int:rule_id>/remove |
Restore one ignored condition; no discovery evidence is changed. | Admin + CSRF |
| POST | /api/v1/placements |
Match an observed device to inventory and give it one physical placement. | Admin + CSRF |
| POST | /api/v1/rack-arrangement |
Move rack devices and reorder rack tops in one transaction. | Admin + CSRF |
| POST | /api/v1/rack-devices |
Create audited manual equipment, optionally placed in a room container. | Admin + CSRF |
| POST | /api/v1/rack-devices/<int:device_id>/name |
Save a user-owned display name without changing a source observation. | Admin + CSRF |
| POST | /api/v1/rack-devices/<int:device_id>/placement |
Place or move an inventory device between racks. | Admin + CSRF |
| POST | /api/v1/rack-devices/<int:device_id>/unplace |
Remove a device's active placement while preserving its identity. | Admin + CSRF |
| POST | /api/v1/racks/<int:rack_id> |
Edit rack details without invalidating saved equipment placements. | Admin + CSRF |
| POST | /api/v1/racks/<int:rack_id>/delete |
Delete a rack with its rack top, shared shelves, and shelves on top. | Admin + CSRF |
| POST | /api/v1/rooms/<int:room_id> |
Rename a room. | Admin + CSRF |
| POST | /api/v1/rooms/<int:room_id>/delete |
Delete a room with its racks, floor, walls, ceiling, and places. | Admin + CSRF |
| GET | /api/v1/rooms/<int:room_id>/layout |
Return one room's containers, rack footprints, and canonical equipment. | Signed-in |
| POST | /api/v1/sites/<int:site_id> |
Rename a location (site). | Admin + CSRF |
| POST | /api/v1/sites/<int:site_id>/delete |
Delete a location (site), its rooms, racks, and places. | Admin + CSRF |
| GET | /api/v1/sources |
Return each discovery source's collection state, and nothing else. | Signed-in |
| GET | /api/v1/topology |
Return recognized physical equipment and evidence-backed cable links. | Signed-in |
| GET | /api/v1/wan |
Return each gateway's internet uplink state and one-day history. | Signed-in |