[{"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

Create Network Pool

Description

Create a Network Pool

Request

Request

URL

URL


post
https://sfo-vcf01.rainpole.io/v1/network-pools
Copy

Request Body

Request Body

NetworkPool of type(s) application/json Required

Specification of the Network pool to create

{
	"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

Response

Response

200 OK Response Body>

Response Body

200 OK

Returns NetworkPool of type(s) application/json
{
	"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


201 Created Response Body>

Response Body

201 Created

Returns NetworkPool of type(s) application/json

The newly created network pool

{
	"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
400

Errors due to network pool validations failures


Error
500

Unexpected error

Code Samples

Code Samples

cURL Command

curl -X POST -H "Content-Type: application/json" -d '{"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}]}' https://sfo-vcf01.rainpole.io/v1/network-pools


[{"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?