Sign in
Subnets

List all subnets

Returns all subnets accessible to the authenticated user or daemon. Daemons can only access subnets within their assigned network. Supports pagination via limit and offset query parameters, and ordering via group_by, order_by, and order_direction.

get/api/v1/subnets

Query parameters

network_idstring uuid nullable

Filter by network ID

group_by'created_at' | 'name' | 'cidr' | 'subnet_type' | 'updated_at' | 'network_id'

Fields that subnets can be ordered/grouped by.

Primary ordering field (used for grouping). Always sorts ASC to keep groups together.

order_by'created_at' | 'name' | 'cidr' | 'subnet_type' | 'updated_at' | 'network_id'

Fields that subnets can be ordered/grouped by.

Secondary ordering field (sorting within groups or standalone sort).

order_direction'asc' | 'desc'

Direction for ORDER BY clauses.

Direction for order_by field (group_by always uses ASC).

limitinteger nullable

Maximum number of results to return (1-1000, default: 50). Use 0 for no limit.

offsetinteger nullable

Number of results to skip. Default: 0.

Response

List of subnets

errorstring nullable
successboolean required

Example response

{
  "data": [
    {
      "cidr": "192.168.1.0/24",
      "created_at": "2026-01-15T10:30:00Z",
      "description": "Local area network",
      "id": "550e8400-e29b-41d4-a716-446655440004",
      "name": "LAN",
      "network_id": "550e8400-e29b-41d4-a716-446655440002",
      "source": {
        "type": "Manual"
      },
      "subnet_type": "Lan",
      "tags": [],
      "updated_at": "2026-01-15T10:30:00Z"
    }
  ],
  "meta": {
    "api_version": 1,
    "pagination": {
      "has_more": true,
      "limit": 50,
      "offset": 0,
      "total_count": 142
    },
    "server_version": "0.16.1"
  }
}

Changes