Data model

Phase 1 inventory is defined in Prisma (platform/prisma/schema.prisma). The API and console read and write these models; REST resource names and bulk import types generally align with the Prisma model names below.

Conventions

Identifiers — Primary keys are UUIDs on core resources unless noted in the schema.
Tenancy — Data is scoped under Organization (and optionally Project where modeled).
Soft delete — Many models include deletedAt; filtered queries exclude tombstoned rows.
Source of truth — Field lists, relations, and indexes are defined only in Prisma; this page lists every model with a short gloss.

API mapping. REST paths and resourceType strings for resource views, bulk import, and search follow the same vocabulary as these models—see REST & OpenAPI for HTTP details.

Object families

The schema spans DCIM (sites, racks, devices, cabling), IPAM (VRFs, prefixes, addresses), WAN circuits and providers, identity and automation (users, tokens, jobs, webhooks), and supporting catalogs (device types, roles, tags). Use the index below to jump to a type, or open Prisma for full relation graphs.

Foundation — Organization, User, ApiToken, Team, Tag, AuditEvent
Physical & virtual inventory — Location, Rack, Device, Module, VirtualMachine, VirtualChassis, ports and cables
IPAM — Vrf, Prefix, IpAddress, Vlan, RouteTarget
Circuits & carriers — Circuit, Provider, segments and terminations
Automation — JobDefinition, JobRun, WebhookSubscription, ChangeRequest

All object types

Each row is an anchor you can link to (e.g. data-model.html#Device). Authoritative field lists live in Prisma.

Model	Summary
`ApiToken`	Automation bearer token with role and optional expiry.
`AuditEvent`	Immutable change record for resources.
`Cable`	Link between two interfaces.
`ChangeRequest`	See schema.prisma for fields and relations.
`Circuit`	WAN/link inventory with provider and segments.
`CircuitDiversityGroup`	See schema.prisma for fields and relations.
`CircuitSegment`	See schema.prisma for fields and relations.
`CircuitTermination`	See schema.prisma for fields and relations.
`CircuitType`	See schema.prisma for fields and relations.
`CloudNetwork`	See schema.prisma for fields and relations.
`CloudService`	See schema.prisma for fields and relations.
`Cluster`	See schema.prisma for fields and relations.
`ConsoleConnection`	See schema.prisma for fields and relations.
`ConsolePort`	See schema.prisma for fields and relations.
`ConsoleServerPort`	See schema.prisma for fields and relations.
`Contact`	See schema.prisma for fields and relations.
`Controller`	See schema.prisma for fields and relations.
`Device`	Physical or logical network element; type, role, rack placement, status.
`DeviceBay`	See schema.prisma for fields and relations.
`DeviceFamily`	See schema.prisma for fields and relations.
`DeviceGroup`	See schema.prisma for fields and relations.
`DeviceGroupMember`	See schema.prisma for fields and relations.
`DeviceRedundancyGroup`	See schema.prisma for fields and relations.
`DeviceRedundancyGroupMember`	See schema.prisma for fields and relations.
`DeviceRole`	See schema.prisma for fields and relations.
`DeviceType`	See schema.prisma for fields and relations.
`DynamicGroup`	See schema.prisma for fields and relations.
`FrontPort`	See schema.prisma for fields and relations.
`Interface`	Network interface on a device; L2/L3 attachment point.
`InterfaceRedundancyGroup`	See schema.prisma for fields and relations.
`InterfaceRedundancyGroupMember`	See schema.prisma for fields and relations.
`InventoryItem`	See schema.prisma for fields and relations.
`IpAddress`	Host address assignment within a prefix.
`IpamNamespace`	See schema.prisma for fields and relations.
`JobDefinition`	Named automation job with optional approval.
`JobRun`	Execution instance with status and idempotency key.
`Location`	Facility hierarchy node; parent/child locations and racks.
`LocationType`	See schema.prisma for fields and relations.
`Manufacturer`	See schema.prisma for fields and relations.
`Module`	See schema.prisma for fields and relations.
`ModuleBay`	See schema.prisma for fields and relations.
`ModuleType`	See schema.prisma for fields and relations.
`MplsDomain`	See schema.prisma for fields and relations.
`ObjectTemplate`	See schema.prisma for fields and relations.
`ObservedResourceState`	See schema.prisma for fields and relations.
`Organization`	Tenant root: owns all org-scoped inventory and settings.
`PluginRegistration`	See schema.prisma for fields and relations.
`PowerConnection`	See schema.prisma for fields and relations.
`PowerFeed`	See schema.prisma for fields and relations.
`PowerOutlet`	See schema.prisma for fields and relations.
`PowerPanel`	See schema.prisma for fields and relations.
`PowerPort`	See schema.prisma for fields and relations.
`Prefix`	IPv4/v6 CIDR tree under a VRF.
`Project`	Optional sub-scope under an organization.
`Provider`	Carrier or peer for circuits.
`ProviderNetwork`	See schema.prisma for fields and relations.
`Rack`	Cabinet within a location; hosts devices with U positions.
`RackElevation`	See schema.prisma for fields and relations.
`RackGroup`	See schema.prisma for fields and relations.
`RackReservation`	See schema.prisma for fields and relations.
`RearPort`	See schema.prisma for fields and relations.
`ResourceExtension`	See schema.prisma for fields and relations.
`Rir`	See schema.prisma for fields and relations.
`RouteTarget`	See schema.prisma for fields and relations.
`ServiceInstance`	See schema.prisma for fields and relations.
`SoftwareImageFile`	See schema.prisma for fields and relations.
`SoftwarePlatform`	See schema.prisma for fields and relations.
`SoftwareVersion`	See schema.prisma for fields and relations.
`StatusDefinition`	See schema.prisma for fields and relations.
`Tag`	See schema.prisma for fields and relations.
`TagAssignment`	See schema.prisma for fields and relations.
`Team`	See schema.prisma for fields and relations.
`TenantGroup`	See schema.prisma for fields and relations.
`User`	Interactive account; JSON preferences (e.g. pinned pages).
`VirtualChassis`	See schema.prisma for fields and relations.
`VirtualChassisMember`	See schema.prisma for fields and relations.
`VirtualDeviceContext`	See schema.prisma for fields and relations.
`VirtualMachine`	See schema.prisma for fields and relations.
`Vlan`	See schema.prisma for fields and relations.
`VlanGroup`	See schema.prisma for fields and relations.
`Vpn`	See schema.prisma for fields and relations.
`Vrf`	Layer-3 routing instance; scopes prefixes and RTs.
`WebhookSubscription`	See schema.prisma for fields and relations.
`WirelessNetwork`	See schema.prisma for fields and relations.

← Documentation home