[{"label":"Latest (V1)","version":"latest"}]
horizon-cloud-nextgen

Get All

Description

Return a list of all provider instances.

Request

Request

URL

URL


get
https://cloud.vmwarehorizon.com/admin/v2/providers/{label}/instances
Copy

Path Parameters

Path Parameters

string
label Required

Provider label


Query Parameters

Query Parameters

boolean
include_health_details Optional

If true, health details for each provider instance will be returned


string
org_id Optional

Filter by orgId: non-super users can only query for their own orgIds


string
page Optional

Page number to retrieve.


string
search Optional

Search Criteria. Please see model definition for list of searchable fields.

search example
map[code:"id $eq id-1"
]

string
size Optional

Size of each page.


array of string
sort Optional

Ascending/Descending. Format is property,{asc|desc} and default is ascending.

Parameter Serialization Style: form Explode:true

Authentication

Authentication

This operation uses the following authentication methods.

Response

Response

Response Body

Response Body

200 OK returns PageProviderInstanceTOV2 of type */*

Successfully retrieved provider instances

{
	"content": [
		{
			"createdAt": "string",
			"credentialId": "0123456789",
			"denyOperations": [
				"EDGE_DEPLOYMENT"
			],
			"edgeDeploymentId": "0123456789",
			"hdc": {
				"edgeHubUrl": "string",
				"id": "string",
				"modelVersion": 0,
				"name": "string",
				"url": "string",
				"vmHub": {
					"name": "string",
					"url": "string"
				},
				"vmHubName": "string",
				"vmHubURL": "string"
			},
			"healthStatusDetails": {
				"errorDetails": [
					{
						"cause": "ErrorDetail Object",
						"code": "string",
						"detail": "string",
						"domain": "string",
						"message": "string",
						"parameters": {
							"key": "string"
						}
					}
				],
				"providerInstanceHealthStatus": "OK|ERROR|WARNING",
				"updatedAt": "string",
				"version": 0
			},
			"id": "0123456789",
			"infraTwinId": "0123456789",
			"infraTwinSyncStatus": "READY",
			"infrastructureLinks": {
				"key": "string"
			},
			"location": "US",
			"name": "My Instance Name",
			"orgId": "0123456789",
			"primaryProvider": false,
			"providerDetails": {
				"data": {
					"key": "string"
				},
				"method": "ByAppRegistration"
			},
			"providerLabel": "AZURE",
			"resourceTags": {
				"key": "string"
			},
			"updatedAt": "string",
			"version": 0
		}
	],
	"empty": false,
	"first": false,
	"last": false,
	"number": 0,
	"numberOfElements": 0,
	"pageable": {
		"offset": 0,
		"pageNumber": 0,
		"pageSize": 0,
		"paged": false,
		"sort": {
			"empty": false,
			"sorted": false,
			"unsorted": false
		},
		"unpaged": false
	},
	"size": 0,
	"sort": {
		"empty": false,
		"sorted": false,
		"unsorted": false
	},
	"totalElements": 0,
	"totalPages": 0
}
content Optional

Searchable Fields are “id”, “name”, “providerLabel”, “edgeDeploymentId”, “infraTwinSyncStatus”


boolean
empty Optional

boolean
first Optional

boolean
last Optional

integer as int32
number Optional

integer as int32
numberOfElements Optional

pageable Optional

integer as int32
size Optional

sort Optional

integer as int64
totalElements Optional

integer as int32
totalPages Optional
Errors

Errors

401

Unauthorized


403

Forbidden


404

Not Found


423

Provider disabled

Code Samples

Code Samples

cURL Command

curl https://cloud.vmwarehorizon.com/admin/v2/providers/{label}/instances


Feedback

Was this page helpful?