Circuits

The Circuits Aether tracks carrier connectivity — the providers you buy from, the networks they offer, and the circuits you run over them. It’s where the WAN meets your estate.

The Circuits list with provider, type, and statuspublic/screenshots/circuits-list.png

How it fits together

Providers are the carriers — the companies you contract with.
Provider Networks are the networks a provider offers (a regional backbone, a transit product), each belonging to one provider.
Circuit Types classify circuits by technology or service tier.
Circuits are the instances — a specific link of a given type, bought from a provider, with its carrier circuit ID, commit rate, and status.

Modules

Providers

The carriers — the telcos and ISPs you buy connectivity from, with the account and operational details that identify you to them.

Fields

Field	Type	Notes
`name`	string · required	Provider name.
`slug`	string	URL-safe identifier; unique. Derived from `name` when omitted.
`asn`	integer	Autonomous System Number.
`account`	string	Your account number with the provider.
`portalUrl`	string	Link to the provider’s customer portal.
`noc`	string	NOC contact details.
`description`	string	Free-text notes.

API — GET/POST /api/providers, GET/PATCH/DELETE /api/providers/{id}.

Notes — search matches across name and description; sort accepts name (default) and createdAt.

The Providers list with ASN and account detailspublic/screenshots/circuits-providers.png

Provider Networks

The networks a provider offers — a regional backbone, a transit product — each belonging to one provider.

Fields

Field	Type	Notes
`name`	string · required	Network name.
`providerId`	uuid → Provider	Owning provider. Deleting the provider cascades — its networks are removed.
`serviceId`	string	The provider’s own service/reference ID for the network.
`description`	string	Free-text notes.

API — GET/POST /api/provider-networks, GET/PATCH/DELETE /api/provider-networks/{id}.

Notes — search matches across name and description; sort accepts name (default) and createdAt.

Circuit Types

Classification for circuits — DIA, MPLS, dark fibre, broadband, and the like — so you can filter and report by service kind.

Fields

Field	Type	Notes
`name`	string · required	Type name.
`slug`	string	URL-safe identifier; unique. Derived from `name` when omitted.
`description`	string	Free-text notes.

API — GET/POST /api/circuit-types, GET/PATCH/DELETE /api/circuit-types/{id}.

Notes — search matches across name and description; sort accepts name (default) and createdAt.

Circuits

The circuit instances — a specific link of a given type, bought from a provider, with its carrier circuit ID, commit rate, and operational status.

Fields

Field	Type	Notes
`name`	string · required	Display name for the circuit.
`cid`	string · required	Carrier circuit ID.
`providerId`	uuid → Provider	Set null if the provider is deleted.
`typeId`	uuid → Circuit Type	Set null if the type is deleted.
`status`	string · required	Defaults to `active`.
`installDate`	date	Date the circuit was installed.
`commitRate`	integer	Committed rate (CIR), in the unit your estate standardises on.
`description`	string	Free-text notes.

API — GET/POST /api/circuits, GET/PATCH/DELETE /api/circuits/{id}.

Notes — search matches across name, cid, and description; sort accepts name (default) and createdAt. providerId and typeId are set null on delete, so a circuit survives the removal of its provider or type — it just loses the reference.

Good to know

Build the carrier side first. Create the provider, then its networks and the circuit types, before adding circuit instances that reference them.
Each module supports full CRUD — list, create, edit, and delete — via both the app UI and the REST API.

API

Resources are exposed under /api/providers, /api/provider-networks, /api/circuit-types, and /api/circuits — see the API reference. List endpoints accept page, pageSize, search, sort, and order.