network

Modify network

Modifies the details of a specific SDN private network. The Utility and public networks cannot be modified.

put/1.3/network/{uuid}

Request

  • Base URL: https://api.upcloud.com
  • URL: https://api.upcloud.com/1.3/network/{uuid}
  • Auth: HTTP bearer

Path parameters

uuidstring uuid required

Universally unique identifier

Example:0414e0d7-4436-4037-9dd8-6eaf47dce599

UUID of the network.

Request body

Example request

{
  "network": {
    "type": "public",
    "zone": "fi-hel1",
    "tags": {
      "tags": {
        "tag": [
          {
            "name": "PROD",
            "description": "Production servers",
            "servers": {
              "server": [
                "0077fa3d-32db-4b09-9f5f-30d9e9afb565"
              ]
            }
          }
        ]
      }
    },
    "labels": {
      "label": [
        {
          "key": "env",
          "value": "prod"
        },
        {
          "key": "team",
          "value": "network"
        }
      ]
    },
    "router": "0414e0d7-4436-4037-9dd8-6eaf47dce599",
    "ip_networks": {
      "ip_network": [
        {
          "family": "IPv4"
        }
      ]
    }
  }
}

Response

Updated network details.

Example response

{
  "network": {
    "evi": 1234,
    "grt_export": "no",
    "ip_networks": {
      "ip_network": [
        {
          "family": "IPv4",
          "address": "192.168.150.0/24",
          "dhcp": "yes",
          "dhcp_dns": [
            "192.168.150.1",
            "192.168.150.254"
          ],
          "gateway": "192.168.150.1"
        }
      ]
    },
    "name": "Example network",
    "network_features": [
      "allow-linklocal-address",
      "allow-overlapping-ip-network",
      "managed-by-service"
    ],
    "parent_network": "037b0e4b-2734-4d5d-89ba-1737fc4593bf",
    "peerings": {
      "peering": [
        {
          "name": "Peering A->B",
          "state": "pending-peer",
          "uuid": "0fc82c18-1e5e-4076-afcd-3b85869800e7"
        }
      ]
    },
    "router": "0414e0d7-4436-4037-9dd8-6eaf47dce599",
    "services": {
      "service": [
        {
          "name": "OBJECT-STORAGE",
          "service_routes": [
            "10.10.10.0/24"
          ]
        }
      ]
    },
    "type": "private",
    "uuid": "039a8811-e279-46c2-8e45-1962767f5a4c",
    "zone": "fi-hel1"
  }
}

Changes

No recorded changes to this operation across all 1 revision of this API.