PREFIX: IP Prefix
The PREFIX entity represents an IP network prefix in CIDR notation, with hierarchical nesting, VRF scoping, and VLAN/site assignment.
PREFIX definition shipped with DemandFlow. Administrators can add, remove, rename, or re-type fields, change which ones are required, and alter the layout from the Definitions screen in Settings. Your tenant's current schema may differ from what is shown here. To read the current definition at any time, GET the DEFINITION object whose id matches PREFIX.Entity properties
| Property | Value |
|---|---|
| Entity code | PREFIX |
| Display name | IP Prefix |
| Plural | IP Prefixes |
| Level | 41300 |
Use cases
PREFIX is the core building block of IPAM, representing a CIDR network block (e.g., 10.0.0.0/8, 192.168.1.0/24). Prefixes nest hierarchically: a /16 contains /24s which contain /32 host addresses. The status field distinguishes Container (parent-only, not directly assigned), Active (in use), Reserved (allocated but not yet deployed), and Deprecated (being phased out). Each prefix can be scoped to a VRF for routing isolation, a SITE for geographic context, and a VLAN for L2 association. The role field mirrors VLAN roles for consistency. The isPool flag marks prefixes used for automatic IP allocation (e.g., DHCP pools). The related lists show child prefixes (smaller blocks within this prefix) and individual IP addresses allocated from this prefix. The aggregate lookup links to the top-level RIR allocation this prefix falls under.
Fields
General
| Field | Type | Required | Notes |
|---|---|---|---|
name | text | Yes | CIDR notation (e.g., 10.0.0.0/24, 2001:db8::/32). |
description | text (multi-line) | Description. | |
status | enum | Yes | Status. Valid ids: 1 (Container), 2 (Active), 3 (Reserved), 4 (Deprecated). |
role | enum | Role. Valid ids: 1 (Production), 2 (Development), 3 (Management), 4 (Storage), 5 (Voice), 6 (Guest), 7 (DMZ), 8 (Monitoring), 9 (Backup), 10 (Transit), 11 (Loopback), 12 (Point-to-Point). | |
isPool | boolean | Addresses can be automatically allocated from this prefix. | |
vrf | reference → VRF | Routing domain for this prefix (Global if empty). | |
site | reference → SITE | Site. | |
vlan | reference → VLAN | VLAN. | |
aggregate | reference → AGGREGATE | Top-level RIR allocation this prefix falls under. | |
totalAddresses | number | Total Addresses. Read-only. | |
usedAddresses | number | Used Addresses. Read-only. | |
availableAddresses | number | Available Addresses. Read-only. | |
utilizationPercent | gauge | Utilisation %. Read-only. |
Additional panels
- Activity timeline panel attached.
Relationships
- Lookups:
vrfpoints atVRFrecord;sitepoints atSITErecord;vlanpoints atVLANrecord;aggregatepoints atAGGREGATErecord. - Related lists:
PREFIXvia formatSUB;IPADDRESSvia formatSUB.
Creating a IP Prefix via the API
POST /v1/objects
Authorization: Bearer <your-pat>
Content-Type: application/json
{
"entity": "PREFIX",
"level": 41300,
"comboKey": "SUB:<your-sub-id>|ENT:",
"name": "Example",
"status": "1",
"description": "Long description text.",
"role": "1"
}Listing PREFIX records
# All ip prefixes in your tenant
GET /v1/entities/PREFIX/SUB