Sign in

v62

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

Update a subnet

Updates subnet properties. If the CIDR is being changed, validates that all existing ip_addresses on this subnet have IPs within the new CIDR range.

put/api/v1/subnets/{id}

Path parameters

idstring uuid required

Subnet ID

Request body

cidrstring required

Subnet in CIDR notation, IPv4 or IPv6.

descriptionstring nullable

Free-text notes about the subnet.

namestring required

Human-facing name for this subnet.

network_idstring uuid required

The network this entity belongs to.

subnet_type'Internet' | 'Remote' | 'Gateway' | 'VpnTunnel' | 'Dmz' | 'Lan' | 'WiFi' | 'IoT' | 'Guest' | 'DockerBridge' | 'PodmanBridge' | 'MacVlan' | 'IpVlan' | 'Management' | 'Storage' | 'Loopback' | 'Unknown' required
tagsstring[] required

Tags assigned to this entity.

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

{
  "cidr": "192.168.1.0/24",
  "created_at": "2026-01-15T10:30:00Z",
  "description": "Local area network",
  "first_discovery_id": null,
  "id": "550e8400-e29b-41d4-a716-446655440004",
  "last_discovery_id": null,
  "last_seen_at": "2026-01-15T10:30:00Z",
  "lineage_id": null,
  "name": "LAN",
  "network_id": "550e8400-e29b-41d4-a716-446655440002",
  "source": {
    "type": "Manual"
  },
  "subnet_type": "Lan",
  "tags": [],
  "updated_at": "2026-01-15T10:30:00Z",
  "valid_from": "2026-01-15T10:30:00Z",
  "valid_to": null
}

Response

Subnet updated

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": {
    "cidr": "192.168.1.0/24",
    "created_at": "2026-01-15T10:30:00Z",
    "description": "Local area network",
    "first_discovery_id": null,
    "id": "550e8400-e29b-41d4-a716-446655440004",
    "last_discovery_id": null,
    "last_seen_at": "2026-01-15T10:30:00Z",
    "lineage_id": null,
    "name": "LAN",
    "network_id": "550e8400-e29b-41d4-a716-446655440002",
    "source": {
      "type": "Manual"
    },
    "subnet_type": "Lan",
    "tags": [],
    "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"
  }
}