v1
latestOpenAPI 3.0.0Apache v2 License2026-07-148442331.2 MBipam
patch/ipam/ip-addresses/{id}/
Request body
addressstring required
IPv4 or IPv6 address (with mask)
assigned_objectobject
assigned_object_idinteger nullable
assigned_object_typestring nullable
commentsstring
createdstring date-time nullable
custom_fieldsobject
descriptionstring
displaystring
dns_namestring
Hostname or FQDN (not case-sensitive)
familystring
idinteger
last_updatedstring date-time nullable
nat_insideinteger nullable
The IP for which this address is the "outside" IP
role'loopback' | 'secondary' | 'anycast' | 'vip' | 'vrrp' | 'hsrp' | 'glbp' | 'carp'
The functional role of this IP
status'active' | 'reserved' | 'deprecated' | 'dhcp' | 'slaac'
The operational status of this IP
tenantinteger nullable
urlstring uri
vrfinteger nullable
Response
addressstring required
IPv4 or IPv6 address (with mask)
assigned_objectobject
assigned_object_idinteger nullable
assigned_object_typestring nullable
commentsstring
createdstring date-time nullable
custom_fieldsobject
descriptionstring
displaystring
dns_namestring
Hostname or FQDN (not case-sensitive)
idinteger
last_updatedstring date-time nullable
urlstring uri