[{"label":"Latest (4.4.0)","version":"latest"},{"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

Get Domains

Description

Get the Domains

Request

Request

URL

URL


get
https://sfo-vcf01.rainpole.io/v1/domains
Copy

Query Parameters

Query Parameters

string
type Optional

The type of the domain


Response

Response

Response Body

Response Body

200 OK returns PageOfDomain of type(s) application/json
{
	"elements": [
		{
			"capacity": {
				"cpu": {
					"total": {
						"unit": "Hz",
						"value": 0
					},
					"used": {
						"unit": "Hz",
						"value": 0
					}
				},
				"memory": {
					"total": {
						"unit": "B",
						"value": 0
					},
					"used": {
						"unit": "B",
						"value": 0
					}
				},
				"storage": {
					"total": {
						"unit": "B",
						"value": 0
					},
					"used": {
						"unit": "B",
						"value": 0
					}
				}
			},
			"clusters": [
				{
					"id": "string"
				}
			],
			"id": "string",
			"name": "string",
			"nsxtCluster": {
				"id": "string",
				"vip": "string",
				"vipFqdn": "string"
			},
			"status": "string",
			"tags": [
				{
					"categoryId": "string",
					"categoryName": "string",
					"id": "string",
					"name": "string"
				}
			],
			"type": "string",
			"vcenters": [
				{
					"fqdn": "string",
					"id": "string"
				}
			]
		}
	],
	"pageMetadata": {
		"pageNumber": 0,
		"pageSize": 0,
		"totalElements": 0,
		"totalPages": 0
	}
}
array of Domain
elements Optional

The list of elements included in this page


pageMetadata Optional

Pageable elements pagination metadata information

Errors

Errors

400

Bad Request


500

InternalServerError

Code Samples

Code Samples

cURL Command

curl https://sfo-vcf01.rainpole.io/v1/domains


[{"label":"Latest (4.4.0)","version":"latest"},{"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?