v62

latestOpenAPI 3.1.0Dual (AGPL3.0, Commercial License Available)raw.githubusercontent.com2026-08-03211303932.5 KB

IP Addresses

Update an IP address Position must be within valid range and not conflict with other IP addresses.

put/api/v1/ip-addresses/{id}

Path parameters

idstring uuid required

IP address ID

Request body

host_idstring uuid required

The host this entity belongs to.

ip_addressstring required

IPv4 or IPv6 address.

mac_addressstring nullable

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

namestring nullable required

Human-facing name for this IP address.

network_idstring uuid required

The network this entity belongs to.

positioninteger

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

subnet_idstring uuid required

The subnet this entity belongs to.

created_atstring date-time required

When this record was first created.

first_discovery_idstring uuid nullable

The discovery that first observed this entity.

idstring uuid required

Server-assigned unique identifier.

last_discovery_idstring uuid nullable

The most recent discovery that observed this entity.

last_seen_atstring date-time

When a discovery last observed this entity.

lineage_idstring uuid nullable

Stable identifier shared by every revision of the same entity across its history.

updated_atstring date-time required

When this record was last modified.

valid_fromstring date-time

Start of the interval this revision was current for (SCD2 history).

valid_tostring date-time nullable

End of the interval this revision was current for. null while it is the live revision.

Example request

{
  "created_at": "2026-01-15T10:30:00Z",
  "first_discovery_id": null,
  "host_id": "550e8400-e29b-41d4-a716-446655440003",
  "id": "550e8400-e29b-41d4-a716-446655440005",
  "ip_address": "192.168.1.100",
  "last_discovery_id": null,
  "last_seen_at": "2026-01-15T10:30:00Z",
  "lineage_id": null,
  "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",
  "valid_from": "2026-01-15T10:30:00Z",
  "valid_to": null
}

Response

IP address updated successfully

errorstring nullable

Human-readable failure message. Omitted on success.

successboolean required

true when the request succeeded. false responses carry error instead of data.

Example response

{
  "data": {
    "created_at": "2026-01-15T10:30:00Z",
    "first_discovery_id": null,
    "host_id": "550e8400-e29b-41d4-a716-446655440003",
    "id": "550e8400-e29b-41d4-a716-446655440005",
    "ip_address": "192.168.1.100",
    "last_discovery_id": null,
    "last_seen_at": "2026-01-15T10:30:00Z",
    "lineage_id": null,
    "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",
    "valid_from": "2026-01-15T10:30:00Z",
    "valid_to": null
  },
  "meta": {
    "api_version": 1,
    "server_version": "0.17.7"
  }
}