Virtual networks

Get virtual network

GET/v1/networking/virtual-networks/{id}

Gets a network with its IP blocks.

curl --request GET \
  --url https://api.serverside.com/v1/networking/virtual-networks/{id} \
  --header 'Authorization: Bearer <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,
    "ipBlocks": [
      {
        "id": "3c90c3cc-0d44-4b50-8888-8dd25736052a",
        "createdAt": "2026-01-15T09:30:00Z",
        "networkId": "3c90c3cc-0d44-4b50-8888-8dd25736052a",
        "datacenter": {
          "id": "3c90c3cc-0d44-4b50-8888-8dd25736052a",
          "code": "<string>",
          "name": "<string>",
          "city": "<string>",
          "state": "<string>",
          "countryCode": "<string>",
          "facility": "<string>"
        },
        "ipVersion": "V4",
        "cidr": "<string>",
        "gateway": "<string>",
        "subnetMask": "<string>",
        "prefixLength": 123,
        "usedAddressCount": 123,
        "availableAddressCount": 123
      }
    ]
  }
}

Autorisations

Authorizationstringheaderobligatoire
Organization API key (org_...), created in the cloud console at https://cloud.serverside.com and shown once, sent as Authorization: Bearer <key>. It authenticates as the organization.

Permission requise : organization.networking.read

Paramètres de chemin

idstring<uuid>obligatoire

Réponse

200 · application/json

OK

successbooleanobligatoire
Valeurs autorisées :true
dataobject | nullobligatoire