DemandFlow Support Centre

IPADDRESS: IP Address

An individual IPv4 or IPv6 address with assignment to an interface, VRF scoping, and DNS/NAT tracking.

Default definition. This article describes the default IPADDRESS 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 IPADDRESS.

Entity properties

Property	Value
Entity code	`IPADDRESS`
Display name	IP Address
Plural	IP Addresses
Level	41400

Use cases

IPADDRESS represents a single host IP address (e.g., 10.0.1.5/24 or 2001:db8::1/64). The CIDR mask is included in the name field to indicate the subnet this address belongs to. Status tracks the assignment state: Active (in use on a device), Reserved (allocated but not configured), Deprecated (being phased out), DHCP (dynamically assigned), and SLAAC (IPv6 auto-configuration).

Fields

Address Details

Field	Type	Required	Notes
`name`	text	Yes	IP address with mask (e.g., 10.0.1.5/24, 2001:db8::1/64)
`description`	text (multi-line)		Description.
`status`	enum	Yes	Valid ids: `1` (Active), `2` (Reserved), `3` (Deprecated), `4` (DHCP), `5` (SLAAC).
`role`	enum		Valid ids: `1` (Loopback), `2` (Secondary), `3` (Anycast), `4` (VIP), `5` (VRRP), `6` (HSRP), `7` (GLBP), `8` (CARP).
`dnsName`	text		FQDN (e.g., server01.dc1.example.com)

Assignment

Field	Type	Notes
`vrf`	reference → `VRF`	Global routing table if empty
`prefix`	reference → `PREFIX`	Parent Prefix.
`assignedInterface`	reference → `COMPPORTINV`	Device interface this IP is configured on

NAT

Field	Type	Required	Notes
`natInside`	reference → `IPADDRESS`		Private/inside IP this address translates to
`natOutside`	reference → `IPADDRESS`		Public/outside IP that translates to this address

Additional panels

Activity timeline panel attached.

Relationships

Lookups: vrf points at a VRF record; prefix points at a PREFIX record; assignedInterface points at a COMPPORTINV record; natInside points at a IPADDRESS record; natOutside points at a IPADDRESS record.

Creating a IP Address via the API

POST /v1/objects
Authorization: Bearer <your-pat>
Content-Type: application/json

{
  "entity":   "IPADDRESS",
  "level":    41400,
  "comboKey": "SUB:<your-sub-id>|ENT:",
  "name": "Example",
  "status": "1",
  "description": "...",
  "role": "1"
}

Listing IP Addresses

# All records in your tenant
GET /v1/entities/IPADDRESS/SUB:<your-sub-id>

DemandFlow Support Centre

IPADDRESS: IP Address

IPADDRESS: IP Address

Entity properties

Use cases

Fields

Additional panels

Relationships

Creating a IP Address via the API

Listing IP Addresses

See also

Was this article helpful?