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.

Authorization

Authorization<token>

User API key (Bearer scp_u_...). Create in Platform > API Keys.

In: header

Request Body

application/json

TypeScript Definitions

Use the request body type in TypeScript.

cidr*string

Subnet in CIDR notation, IPv4 or IPv6.

name*string

Human-facing name for this subnet.

network_id*string

The network this entity belongs to.

source*|||||

Will be automatically set to Manual for creation through API

subnet_type*SubnetType

What kind of subnet this is — physical, virtual, container bridge, and so on.

tags*array<>

Tags assigned to this entity.

virtualization_service_id*|

The container runtime service that owns this bridge network.

Load-bearing for dedup: the same CIDR on two different Docker daemons is two distinct subnets, so bridge rows only merge when this matches as well as the CIDR and network. A foreign key rather than a field inside a JSONB blob because a stale value here is precisely what made a scan add a duplicate bridge row every time (GH #650) — now it cannot be written at all.

cidr_source?|||||||||||||||

How a discovered value reached us.

Every variant here has something that writes it. Sources with no producer are deliberately absent: a rung the applier can never see is a rung nothing can be tested against, and the tier decision is better made by whoever writes the reader than guessed in advance.

Do not derive Ord. A derive compares the variant and then the payload, which would make Probe(Docker) < Probe(Snmp) on declaration order alone. Ordering is only ever [Self::rank].

Externally tagged, which is serde's default and is left unstated for that reason. Thirty-three of these variants carry nothing, and a tag on a variant with no content is a key that distinguishes nothing — "Unspecified", not {"type":"Unspecified"}, in every row of every column. The two that do carry a [ClientProbe] keep it under their own name, {"Probe":"Snmp"}, which tells them apart from each other and from every bare name.

description?|

Free-text notes about the subnet.

Response Body

`application/json`

curl -X PUT "https://example.com/api/v1/subnets/497f6eca-6276-4993-bfeb-53cbbbba6f08" \  -H "Content-Type: application/json" \  -d '{    "cidr": "192.168.1.0/24",    "cidr_source": "DaemonSelfReport",    "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,    "virtualization_service_id": null  }'

{
  "meta": {
    "api_version": 1,
    "server_version": "0.17.17"
  },
  "success": true,
  "data": {
    "cidr": "192.168.1.0/24",
    "cidr_source": "DaemonSelfReport",
    "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,
    "virtualization_service_id": null
  },
  "error": "string"
}

{
  "meta": {
    "api_version": 1,
    "server_version": "0.17.17"
  },
  "success": true,
  "code": "string",
  "error": "string",
  "params": {
    "property1": null,
    "property2": null
  }
}

{
  "meta": {
    "api_version": 1,
    "server_version": "0.17.17"
  },
  "success": true,
  "code": "string",
  "error": "string",
  "params": {
    "property1": null,
    "property2": null
  }
}

Authorization

Path Parameters

Request Body

Response Body

200application/json

400application/json

404application/json

`application/json`

`application/json`

`application/json`