Servers

List service virtual networks

GET/v1/services/baremetal/{id}/spns

curl --request GET \
  --url https://api.serverside.com/v1/services/baremetal/{id}/spns \
  --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,
      "ipv4ChildPrefixes": [
        {
          "id": "3c90c3cc-0d44-4b50-8888-8dd25736052a",
          "datacenter": {
            "id": "3c90c3cc-0d44-4b50-8888-8dd25736052a",
            "name": "<string>",
            "country": "<string>",
            "city": "<string>",
            "state": "<string>",
            "facility": "<string>"
          },
          "network": "203.0.113.0/24",
          "createdAt": "2026-01-15T09:30:00Z",
          "gatewayId": "3c90c3cc-0d44-4b50-8888-8dd25736052a",
          "gateway": {
            "id": "3c90c3cc-0d44-4b50-8888-8dd25736052a",
            "address": "203.0.113.10",
            "state": "FREE"
          },
          "spnId": "3c90c3cc-0d44-4b50-8888-8dd25736052a",
          "spn": {
            "id": "3c90c3cc-0d44-4b50-8888-8dd25736052a",
            "name": "<string>",
            "organization": {
              "id": "3c90c3cc-0d44-4b50-8888-8dd25736052a",
              "name": "<string>"
            },
            "type": "PRIVATE"
          },
          "addresses": [
            {
              "id": "3c90c3cc-0d44-4b50-8888-8dd25736052a",
              "address": "203.0.113.10",
              "state": "FREE"
            }
          ],
          "availableAddressCount": 123,
          "availableAddresses": [
            "<string>"
          ]
        }
      ],
      "ipv6ChildPrefixes": [
        {
          "id": "3c90c3cc-0d44-4b50-8888-8dd25736052a",
          "datacenter": {
            "id": "3c90c3cc-0d44-4b50-8888-8dd25736052a",
            "name": "<string>",
            "country": "<string>",
            "city": "<string>",
            "state": "<string>",
            "facility": "<string>"
          },
          "network": "203.0.113.0/24",
          "createdAt": "2026-01-15T09:30:00Z",
          "gatewayId": "3c90c3cc-0d44-4b50-8888-8dd25736052a",
          "gateway": {
            "id": "3c90c3cc-0d44-4b50-8888-8dd25736052a",
            "address": "203.0.113.10",
            "state": "FREE"
          },
          "spnId": "3c90c3cc-0d44-4b50-8888-8dd25736052a",
          "spn": {
            "id": "3c90c3cc-0d44-4b50-8888-8dd25736052a",
            "name": "<string>",
            "organization": {
              "id": "3c90c3cc-0d44-4b50-8888-8dd25736052a",
              "name": "<string>"
            },
            "type": "PRIVATE"
          },
          "addresses": [
            {
              "id": "3c90c3cc-0d44-4b50-8888-8dd25736052a",
              "address": "203.0.113.10",
              "state": "FREE"
            }
          ]
        }
      ],
      "segmentId": "3c90c3cc-0d44-4b50-8888-8dd25736052a",
      "status": "ATTACHED"
    }
  ],
  "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.baremetal.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