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

Verify

Description

Validate a potential new provider instance, without creating anything.

Request

Request

URL

URL


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

Path Parameters

Path Parameters

string
label Required

Provider label


Request Body

Request Body

ProviderInstanceCreateTOV2 of mimetype application/json Required

newProviderInstance

{
	"denyOperations": [
		"EDGE_DEPLOYMENT"
	],
	"edgeDeploymentId": "0123456789",
	"name": "My Instance Name",
	"orgId": "0123456789",
	"providerDetails": {
		"data": {
			"key": "string"
		},
		"method": "ByAppRegistration"
	},
	"resourceTags": {
		"key": "string"
	}
}
array of string
denyOperations Optional

User defined operations to be deny on this instance

Possible values are: EDGE_DEPLOYMENTTEMPLATE_CREATIONUAG_DEPLOYMENT


string
edgeDeploymentId Optional

EdgeGateway Deployment which we can use to manage and monitor infrastructure


string
name Optional

User defined name for this instance


string
orgId Optional

Org ID that owns this record


providerDetails Optional

map of string
resourceTags Optional

Resource tags that are added to Provider Instance

Authentication

Authentication

This operation uses the following authentication methods.

Response

Response

200 OK

Successfully verified

Errors

Errors

400

Bad Request


401

Unauthorized


403

Forbidden


404

Not Found


409

Conflict


423

Provider disabled


500

Unexpected internal server error

Code Samples

Code Samples

cURL Command

curl -X POST -H "Content-Type: application/json" -d '{"denyOperations":["EDGE_DEPLOYMENT"],"edgeDeploymentId":"0123456789","name":"My Instance Name","orgId":"0123456789","providerDetails":{"data":{"key":"string"},"method":"ByAppRegistration"},"resourceTags":{"key":"string"}}' https://cloud.vmwarehorizon.com/admin/v2/providers/{label}/instances/verify
Vendor Extensions

Vendor Extensions

This operation contains the following vendor extensions defined in the spec:
x-codegen-request-body-name: newProviderInstance


Feedback

Was this page helpful?