Virtual networks

List virtual networks

GET/v1/networking/spn

curl --request GET \
  --url https://api.serverside.com/v1/networking/spn \
  --header 'X-API-KEY: <api-key>'

{
  "success": true,
  "data": [
    {
      "id": "3c90c3cc-0d44-4b50-8888-8dd25736052a",
      "createdAt": "2026-01-15T09:30:00Z",
      "name": "<string>",
      "type": "PRIVATE",
      "managedBy": "CUSTOMER",
      "localVlanId": 123,
      "ipv4ChildPrefixCount": 123,
      "ipv6ChildPrefixCount": 123
    }
  ],
  "pagination": {
    "totalRecords": 123,
    "currentPage": 123,
    "pageSize": 123,
    "totalPages": 123
  }
}

Authorizations

X-API-KEYstringheaderrequired
Organization API key, created in the cloud console at https://cloud.serverside.com and shown once. It authenticates as the organization.

Required permission: organization.networking.read

Query parameters

searchstring
filterobject
pageinteger<int32>
Limits:1 <= x <= 2147483
pageSizeinteger<int32>
Limits:1 <= x <= 1000
sortColumnstring
ascendingboolean
typeenum<string>
Allowed values:PRIVATEPUBLIC
includeManagedboolean
Default:false

Response

200 · application/json

OK

successboolean
Allowed values:true
dataobject[] | null
paginationobject