Virtual networks

Get virtual network

GET/v1/networking/spn/{id}

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

{
  "success": true,
  "message": "<string>",
  "exception": "<string>",
  "code": "<string>",
  "errors": {},
  "traceId": "<string>",
  "data": {
    "id": "3c90c3cc-0d44-4b50-8888-8dd25736052a",
    "createdAt": "2026-01-15T09:30:00Z",
    "name": "<string>",
    "localVlanId": 123,
    "type": "PRIVATE",
    "managedBy": "CUSTOMER",
    "ipv4ChildPrefixes": [
      {
        "id": "3c90c3cc-0d44-4b50-8888-8dd25736052a",
        "createdAt": "2026-01-15T09:30:00Z",
        "datacenter": {
          "id": "3c90c3cc-0d44-4b50-8888-8dd25736052a",
          "name": "<string>",
          "country": "<string>",
          "city": "<string>",
          "state": "<string>",
          "facility": "<string>"
        },
        "network": "<string>",
        "subnetMask": "<string>",
        "gateway": "<string>",
        "prefixLength": 123,
        "usedAddressCount": 123,
        "availableAddressCount": 123
      }
    ],
    "ipv6ChildPrefixes": [
      {
        "id": "3c90c3cc-0d44-4b50-8888-8dd25736052a",
        "createdAt": "2026-01-15T09:30:00Z",
        "datacenter": {
          "id": "3c90c3cc-0d44-4b50-8888-8dd25736052a",
          "name": "<string>",
          "country": "<string>",
          "city": "<string>",
          "state": "<string>",
          "facility": "<string>"
        },
        "network": "<string>",
        "subnetMask": "<string>",
        "gateway": "<string>",
        "prefixLength": 123,
        "usedAddressCount": 123,
        "availableAddressCount": 123
      }
    ]
  },
  "pagination": {
    "totalRecords": 123,
    "currentPage": 123,
    "pageSize": 123,
    "totalPages": 123
  }
}

Autorisatie

X-API-KEYstringheaderverplicht
Organization API key. Create one in the cloud console at https://cloud.serverside.com; the key is shown once, when it is created.

Padparameters

idstring<uuid>verplicht

Antwoord

200 · application/json

OK

successboolean
messagestring | null
exceptionstring | null
codestring | null
errorsobject | null
traceIdstring | null
dataobject
paginationobject