Virtual networks

List virtual network services

GET/v1/networking/spn/{id}/services

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

{
  "success": true,
  "data": [
    {
      "service": {
        "id": "3c90c3cc-0d44-4b50-8888-8dd25736052a",
        "name": "<string>",
        "locked": true,
        "suspended": true,
        "createdAt": "2026-01-15T09:30:00Z",
        "primaryIpv4": "<string>",
        "primaryIpv6": "<string>",
        "region": {
          "id": "3c90c3cc-0d44-4b50-8888-8dd25736052a",
          "name": "<string>",
          "city": "<string>",
          "state": "<string>",
          "country": "<string>",
          "facility": "<string>",
          "rack": "<string>"
        },
        "operatingSystem": {
          "id": "3c90c3cc-0d44-4b50-8888-8dd25736052a",
          "slug": "<string>",
          "name": "<string>",
          "deployedAt": "2026-01-15T09:30:00Z",
          "username": "<string>"
        }
      },
      "attachments": [
        {
          "segmentId": "3c90c3cc-0d44-4b50-8888-8dd25736052a",
          "isNative": true,
          "status": "ATTACHED",
          "ipv4Addresses": [
            "<string>"
          ],
          "ipv6Addresses": [
            "<string>"
          ]
        }
      ]
    }
  ],
  "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

Path parameters

idstring<uuid>required

Query parameters

searchstring
filterobject
pageinteger<int32>
Limits:1 <= x <= 2147483
pageSizeinteger<int32>
Limits:1 <= x <= 1000
sortColumnstring
ascendingboolean

Response

200 · application/json

OK

successboolean
Allowed values:true
dataobject[] | null
paginationobject