AGGREGATE: Aggregate
Top-level IP allocation from a Regional Internet Registry, representing the organisation's allocated address space.
Default definition. This article describes the default
AGGREGATE 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 AGGREGATE.Entity properties
| Property | Value |
|---|---|
| Entity code | AGGREGATE |
| Display name | Aggregate |
| Plural | Aggregates |
| Level | 41600 |
Use cases
AGGREGATE represents the top-level IP address blocks allocated to the organisation by a Regional Internet Registry (RIR). For example, if ARIN allocated 198.51.100.0/22 to your organisation, that would be an Aggregate record. Aggregates sit above PREFIXes in the hierarchy - all prefixes should ultimately fall within an aggregate. The RIR lookup tracks which registry made the allocation. The dateAllocated field records when the allocation was granted. The related list shows all child PREFIXes carved from this aggregate.
Fields
General: Aggregate Details
| Field | Type | Required | Notes |
|---|---|---|---|
name | text | Yes | CIDR notation (e.g., 198.51.100.0/22) |
rir | reference → RIR | Yes | RIR. |
description | text (multi-line) | Description. | |
dateAllocated | date | Date Allocated. |
Relationships
- Lookups:
rirpoints at aRIRrecord. - Related lists:
PREFIX(viaaggregate).
Creating a Aggregate via the API
POST /v1/objects
Authorization: Bearer <your-pat>
Content-Type: application/json
{
"entity": "AGGREGATE",
"level": 41600,
"comboKey": "SUB:<your-sub-id>|ENT:",
"name": "Prefix",
"rir": "",
"description": "Description"
} Listing Aggregates records
GET /v1/entities/AGGREGATE/SUB