[{"label":"Latest (5.0.0)","version":"latest"},{"version":"4.5.1"},{"version":"4.5.0"},{"version":"4.4.0"},{"version":"4.3.1"},{"link":"https://developer.vmware.com/apis/1126/vmware-cloud-foundation","version":"4.3"},{"link":"https://developer.vmware.com/apis/1077/vmware-cloud-foundation","version":"4.2"},{"link":"https://developer.vmware.com/apis/1032/vmware-cloud-foundation","version":"4.1"},{"link":"https://developer.vmware.com/apis/1002/vmware-cloud-foundation","version":"4.0.1"},{"link":"https://developer.vmware.com/apis/921/vmware-cloud-foundation","version":"4.0"},{"link":"https://developer.vmware.com/apis/925/vmware-cloud-foundation","version":"3.10"},{"link":"https://developer.vmware.com/apis/891/vmware-cloud-foundation","version":"3.9.1"},{"link":"https://developer.vmware.com/apis/723/vmware-cloud-foundation","version":"3.9.0"},{"link":"https://developer.vmware.com/apis/711/vmware-cloud-foundation","version":"3.8.1"},{"link":"https://developer.vmware.com/apis/685/vmware-cloud-foundation","version":"3.8"}]
vcf

Update Network Pool

Description

Update a Network Pool by ID, if it exists

Request

Request

URL

URL


patch
https://sfo-vcf01.rainpole.io/v1/network-pools/{id}
Copy

Path Parameters

Path Parameters

string
id Required

Network Pool ID


Request Body

Request Body

NetworkPoolUpdateSpec of type(s) application/json Required

Network Pool update data

{
	"name": "string"
}
string
name Optional

Name of the Network Pool

Response

Response

Response Body

Response Body

200 OK

Returns NetworkPool of type(s) application/json

Network Pool update completed

{
	"id": "string",
	"name": "string",
	"networks": [
		{
			"freeIps": [
				"string"
			],
			"gateway": "string",
			"id": "string",
			"ipPools": [
				{
					"end": "string",
					"start": "string"
				}
			],
			"mask": "string",
			"mtu": 0,
			"subnet": "string",
			"type": "string",
			"usedIps": [
				"string"
			],
			"vlanId": 0
		}
	]
}
string
id Optional

The ID of the network pool


string
name Optional

User specified name of the network pool


array of Network
networks Optional

Representing the networks associated with the network pool

Errors

Errors

Error
404

Network Pool not found


Error
500

Unexpected error

Code Samples

Code Samples

cURL Command

curl -X PATCH -H "Content-Type: application/json" -d '{"name":"string"}' https://sfo-vcf01.rainpole.io/v1/network-pools/{id}


[{"label":"Latest (5.0.0)","version":"latest"},{"version":"4.5.1"},{"version":"4.5.0"},{"version":"4.4.0"},{"version":"4.3.1"},{"link":"https://developer.vmware.com/apis/1126/vmware-cloud-foundation","version":"4.3"},{"link":"https://developer.vmware.com/apis/1077/vmware-cloud-foundation","version":"4.2"},{"link":"https://developer.vmware.com/apis/1032/vmware-cloud-foundation","version":"4.1"},{"link":"https://developer.vmware.com/apis/1002/vmware-cloud-foundation","version":"4.0.1"},{"link":"https://developer.vmware.com/apis/921/vmware-cloud-foundation","version":"4.0"},{"link":"https://developer.vmware.com/apis/925/vmware-cloud-foundation","version":"3.10"},{"link":"https://developer.vmware.com/apis/891/vmware-cloud-foundation","version":"3.9.1"},{"link":"https://developer.vmware.com/apis/723/vmware-cloud-foundation","version":"3.9.0"},{"link":"https://developer.vmware.com/apis/711/vmware-cloud-foundation","version":"3.8.1"},{"link":"https://developer.vmware.com/apis/685/vmware-cloud-foundation","version":"3.8"}]
vcf
Feedback

Was this page helpful?