Sign in
IP Addresses

Create a new IP address Position is automatically assigned to the end of the host's IP address list.

post/api/v1/ip-addresses

Request body

host_idstring uuid required
ip_addressstring required
mac_addressstring nullable

MAC address discovered from ARP, SNMP, or Docker - immutable once set

namestring nullable required
network_idstring uuid required
positioninteger

Position of this IP address in the host's IP address list (for ordering)

subnet_idstring uuid required
created_atstring date-time required
idstring uuid required
updated_atstring date-time required

Example request

{
  "created_at": "2026-01-15T10:30:00Z",
  "host_id": "550e8400-e29b-41d4-a716-446655440003",
  "id": "550e8400-e29b-41d4-a716-446655440005",
  "ip_address": "192.168.1.100",
  "mac_address": "DE:AD:BE:EF:CA:FE",
  "name": "eth0",
  "network_id": "550e8400-e29b-41d4-a716-446655440002",
  "position": 0,
  "subnet_id": "550e8400-e29b-41d4-a716-446655440004",
  "updated_at": "2026-01-15T10:30:00Z"
}

Response

IP address created successfully

errorstring nullable
successboolean required

Example response

{
  "data": {
    "created_at": "2026-01-15T10:30:00Z",
    "host_id": "550e8400-e29b-41d4-a716-446655440003",
    "id": "550e8400-e29b-41d4-a716-446655440005",
    "ip_address": "192.168.1.100",
    "mac_address": "DE:AD:BE:EF:CA:FE",
    "name": "eth0",
    "network_id": "550e8400-e29b-41d4-a716-446655440002",
    "position": 0,
    "subnet_id": "550e8400-e29b-41d4-a716-446655440004",
    "updated_at": "2026-01-15T10:30:00Z"
  },
  "meta": {
    "api_version": 1,
    "server_version": "0.16.1"
  }
}

Changes