IPRANGE: IP Range
A continuous range of IP addresses within a prefix, typically used for DHCP pools or static allocation blocks.
Default definition. This article describes the default
IPRANGE 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 IPRANGE.Entity properties
| Property | Value |
|---|---|
| Entity code | IPRANGE |
| Display name | IP Range |
| Plural | IP Ranges |
| Level | 41700 |
Use cases
IPRANGE represents a continuous block of IP addresses within a PREFIX, defined by start and end addresses rather than CIDR notation. Common uses include DHCP pools (10.0.1.100 - 10.0.1.200), static allocation blocks for servers, or reserved ranges for network infrastructure. The VRF lookup scopes the range to a routing domain.
Fields
Range Details
| Field | Type | Required | Notes |
|---|---|---|---|
name | text | Yes | Name. |
startAddress | text | Yes | First IP in range (e.g., 10.0.1.100) |
endAddress | text | Yes | Last IP in range (e.g., 10.0.1.200) |
size | number | Number of addresses in this range | |
description | text (multi-line) | Description. |
Assignment
| Field | Type | Required | Notes |
|---|---|---|---|
status | enum | Yes | Valid ids: 1 (Active), 2 (Reserved), 3 (Deprecated). |
role | enum | Valid ids: 1 (DHCP Pool), 2 (Static Allocation), 3 (Infrastructure), 4 (Reserved), 5 (Management). | |
vrf | reference → VRF | VRF. | |
prefix | reference → PREFIX | Parent Prefix. |
Relationships
- Lookups:
vrfpoints at aVRFrecord;prefixpoints at aPREFIXrecord.
Creating a IP Range via the API
POST /v1/objects
Authorization: Bearer <your-pat>
Content-Type: application/json
{
"entity": "IPRANGE",
"level": 41700,
"comboKey": "SUB:<your-sub-id>|ENT:",
"name": "Example",
"startAddress": "...",
"endAddress": "...",
"status": "1"
}
Listing IP Ranges
# All records in your tenant
GET /v1/entities/IPRANGE/SUB:<your-sub-id>