Virtual networks

List virtual networks

GET/v1/networking/virtual-networks

Lists the organization's private and public networks, leaving out system-managed networks unless includeManaged is set.

curl --request GET \
  --url https://api.serverside.com/v1/networking/virtual-networks \
  --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
        }
      ]
    }
  ],
  "pagination": {
    "totalRecords": 123,
    "page": 123,
    "pageSize": 123,
    "totalPages": 123
  }
}

Autorisierung

Authorizationstringheadererforderlich
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.

Erforderliche Berechtigung: organization.networking.read

Query-Parameter

searchstring
filterobject
pageinteger<int32>
Grenzen:1 <= x <= 2147483
pageSizeinteger<int32>
Grenzen:1 <= x <= 1000
sortColumnstring
ascendingboolean
typeenum<string>
Zulässige Werte:PRIVATEPUBLIC
includeManagedboolean
Standard:false

Antwort

200 · application/json

successbooleanerforderlich
Zulässige Werte:true
dataobject[] | nullerforderlich
paginationobject

Autorisierung

Query-Parameter

Antwort

Fußzeile