Virtual networks

Create virtual network

POST/v1/networking/spn

curl --request POST \
  --url https://api.serverside.com/v1/networking/spn \
  --header 'X-API-KEY: <api-key>' \
  --header 'Content-Type: application/json' \
  --data '
{
  "localVlanId": 123,
  "type": "PRIVATE",
  "name": "<string>"
}
'

{
  "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>",
    "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": {
          "baseAddress": {
            "addressFamily": "UNSPECIFIED",
            "scopeId": 123,
            "isIPv6Multicast": true,
            "isIPv6LinkLocal": true,
            "isIPv6SiteLocal": true,
            "isIPv6Teredo": true,
            "isIPv6UniqueLocal": true,
            "isIPv4MappedToIPv6": true,
            "address": 123
          },
          "prefixLength": 123
        },
        "createdAt": "2026-01-15T09:30:00Z",
        "gatewayId": "3c90c3cc-0d44-4b50-8888-8dd25736052a",
        "gateway": {
          "id": "3c90c3cc-0d44-4b50-8888-8dd25736052a",
          "address": {
            "addressFamily": "UNSPECIFIED",
            "scopeId": 123,
            "isIPv6Multicast": true,
            "isIPv6LinkLocal": true,
            "isIPv6SiteLocal": true,
            "isIPv6Teredo": true,
            "isIPv6UniqueLocal": true,
            "isIPv4MappedToIPv6": true,
            "address": 123
          },
          "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": {
              "addressFamily": "UNSPECIFIED",
              "scopeId": 123,
              "isIPv6Multicast": true,
              "isIPv6LinkLocal": true,
              "isIPv6SiteLocal": true,
              "isIPv6Teredo": true,
              "isIPv6UniqueLocal": true,
              "isIPv4MappedToIPv6": true,
              "address": 123
            },
            "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": {
          "baseAddress": {
            "addressFamily": "UNSPECIFIED",
            "scopeId": 123,
            "isIPv6Multicast": true,
            "isIPv6LinkLocal": true,
            "isIPv6SiteLocal": true,
            "isIPv6Teredo": true,
            "isIPv6UniqueLocal": true,
            "isIPv4MappedToIPv6": true,
            "address": 123
          },
          "prefixLength": 123
        },
        "createdAt": "2026-01-15T09:30:00Z",
        "gatewayId": "3c90c3cc-0d44-4b50-8888-8dd25736052a",
        "gateway": {
          "id": "3c90c3cc-0d44-4b50-8888-8dd25736052a",
          "address": {
            "addressFamily": "UNSPECIFIED",
            "scopeId": 123,
            "isIPv6Multicast": true,
            "isIPv6LinkLocal": true,
            "isIPv6SiteLocal": true,
            "isIPv6Teredo": true,
            "isIPv6UniqueLocal": true,
            "isIPv4MappedToIPv6": true,
            "address": 123
          },
          "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": {
              "addressFamily": "UNSPECIFIED",
              "scopeId": 123,
              "isIPv6Multicast": true,
              "isIPv6LinkLocal": true,
              "isIPv6SiteLocal": true,
              "isIPv6Teredo": true,
              "isIPv6UniqueLocal": true,
              "isIPv4MappedToIPv6": true,
              "address": 123
            },
            "state": "FREE"
          }
        ]
      }
    ]
  },
  "pagination": {
    "totalRecords": 123,
    "currentPage": 123,
    "pageSize": 123,
    "totalPages": 123
  }
}

Authorizations

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

Body

application/json

localVlanIdinteger<int32>
Limits:11 <= x <= 4094
typeenum<string>
Allowed values:PRIVATEPUBLIC
namestringrequired

Response

200 · application/json

OK

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