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

Get Domains

Description

Get the Domains

Request

URL

get

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

Copy

Query Parameters

string

type Optional

The type of the domain

Response

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",
			"isManagementSsoDomain": false,
			"name": "string",
			"nsxtCluster": {
				"id": "string",
				"vip": "string",
				"vipFqdn": "string"
			},
			"ssoId": "string",
			"ssoName": "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

pageMetadata Optional

Pageable elements pagination metadata information

Errors

Error

400

Bad Request

Error

500

InternalServerError

Code Samples

cURL Command

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

vcf

Domains Operations

put

Assign Tags To Existing Domain Introduced

get

Assignable Tags To Domain Introduced

post

Create Domain

delete

Delete Domain

get

Get Cluster Criteria

get

Get Cluster Criterion

get

Get Cluster Query Response

get

Get Clusters Query Response

get

Get Datastore Criterion Introduced

get

Get Datastore Query Response Introduced

get

Get Datastores Criteria Introduced

get

Get Domain

get

Get Domain Endpoints

get

Get Domain Tag Manager URL

get

Get Domains

get

Get Tags Assigned To Domain

get

Get Tags Assigned To Domains Introduced

post

Post Cluster Query

post

Post Clusters Query

post

Post Datastore Query Introduced

delete

Remove Tags From Domain Introduced

patch

Update Domain Changed

post

Validate Domains Operations

Get Domains

Request

URL

Query Parameters

Response

Response Body

200 OK

Errors

Code Samples

cURL Command

On This Page

Domains Operations

Was this page helpful?