ScanopyScanopy
Subnets

List subnets

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

GET
/api/v1/subnets

Authorization

Authorization<token>

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

In: header

Query Parameters

ids?array<>|

Filter by specific entity IDs (for selective loading)

site_ids?array<>|

Filter by site ID. Repeat the parameter to pass several.

subnet_types?array<string>|

Only subnets of one of these types. Repeat for several.

sources?array<>|

Only subnets that came to exist one of these ways (source.type). Repeat for several.

managed_by?array<>|

Only bridge subnets created by one of these container runtimes. Repeat for several.

user_managed?|

true returns only the subnets the user curates, leaving out the ones Scanopy fabricates (Subnet::is_user_managed).

include_shared_ranges?|

With user_managed=true, also returns the Internet and Remote Network ranges every site is seeded with, once each: one site's copy, from the lowest site id among the sites listed.

tag_ids?array<>|

Filter by tag IDs (returns subnets that have ANY of the specified tags)

tag_sets?array<string>|

Tag sets the subnet must hold one tag from each of. Each entry is a comma-separated list of tag ids. One entry per tag group the list is filtered by.

group_by?|

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

order_by?|

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

group_by_tag_group?|

Group by the tag each row holds from this tag group. Takes the place of group_by.

order_by_tag_group?|

Sort by the position of the tag each row holds from this tag group. Takes the place of order_by.

order_direction?|

Direction for order_by field (group_by always uses ASC).

limit?|

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

offset?|

Number of results to skip. Default: 0.

at?|

As-of timestamp (ISO 8601). When set, returns SCD2 state as of this instant (snapshot view) instead of live state.

stale?|

true returns only subnets discovery hasn't observed within their site's staleness window; false returns only those it has. Omit for both. Evaluated per row against the subnet's own site's window.

search?|

Free-text search. Case-insensitive substring match against the subnet's name, CIDR and description.

Response Body

application/json

curl -X GET "https://example.com/api/v1/subnets"
{
  "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",
      "name_source": "Unspecified",
      "site_id": "550e8400-e29b-41d4-a716-446655440002",
      "source": {
        "type": "Manual"
      },
      "subnet_type": "Lan",
      "subnet_type_source": "Unspecified",
      "tags": [],
      "updated_at": "2026-01-15T10:30:00Z",
      "valid_from": "2026-01-15T10:30:00Z",
      "valid_to": null,
      "virtualization_service_id": null,
      "vlan_ids": [],
      "nesting_depth": 0,
      "nesting_root_id": "e781c93d-18cb-43b2-abff-bb577a79afee",
      "range_evidence": {
        "addresses": [
          "string"
        ],
        "discovery_id": "cdd44607-512c-4795-96df-93dabc33c12d",
        "seen_by_host_ids": [
          "2f368cab-b41f-4b78-9819-2cd18640abef"
        ],
        "sys_names": [
          "string"
        ],
        "widened_by_vlan": true
      },
      "usable_addresses": 0,
      "used_addresses": 0,
      "parent_subnet_id": "2f8c68e8-7421-4a9d-b663-3f5a3a33a761"
    }
  ],
  "meta": {
    "api_version": 1,
    "pagination": {
      "has_more": true,
      "limit": 50,
      "offset": 0,
      "total_count": 142
    },
    "server_version": "0.19.6"
  },
  "success": true,
  "error": "string"
}

Product names and logos are trademarks of their respective owners. See credits.