[{"label":"Latest (V1)","version":"latest"}]

horizon-cloud-nextgen

Delete Proxy Config In Uag Deployment

Description

Marks UAG deployment’s proxy configuration for deletion. Deletion will occur in the background.

Request

URL

delete

https://cloud.vmwarehorizon.com/admin/v2/uag-deployments/{id}/proxy-configuration

Copy

Path Parameters

string

id Required

UAG Deployment ID

Query Parameters

string

org_id Optional

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

Authentication

This operation uses the following authentication methods.

Bearer

Response

Response Body

202 Accepted returns UAGDeploymentTOV2 of type */*

Accepted the request to delete the UAG Deployment

{
	"createdAt": "string",
	"description": "string",
	"errorDetails": [
		{
			"cause": "ErrorDetail Object",
			"code": "string",
			"detail": "string",
			"domain": "string",
			"message": "string",
			"parameters": {
				"key": "string"
			}
		}
	],
	"fqdn": "www.example.com",
	"gateways": [
		{
			"desktopPrivateIp": "string",
			"dmzPrivateIp": "string",
			"errorDetails": [
				{
					"cause": "ErrorDetail Object",
					"code": "string",
					"detail": "string",
					"domain": "string",
					"message": "string",
					"parameters": {
						"key": "string"
					}
				}
			],
			"id": "string",
			"managementPrivateIp": "string",
			"markedForDeletion": false,
			"status": "DELETED",
			"version": "string",
			"vmName": "string"
		}
	],
	"hdc": {
		"edgeHubUrl": "string",
		"id": "string",
		"modelVersion": 0,
		"name": "string",
		"url": "string",
		"vmHub": {
			"name": "string",
			"url": "string"
		},
		"vmHubName": "string",
		"vmHubURL": "string"
	},
	"id": "string",
	"infrastructure": {
		"key": {
			"data": {},
			"id": "string",
			"infrastructureLinks": {},
			"kind": "string"
		}
	},
	"loadBalancer": {
		"fqdn": "string",
		"ipAddress": "string",
		"publicIpEnabled": false
	},
	"location": "US",
	"name": "My Instance Name",
	"numberOfGateways": 2,
	"orgId": "0123456789",
	"passwordCredentialId": "string",
	"privateLoadBalancer": {
		"fqdn": "string",
		"ipAddress": "string",
		"publicIpEnabled": false
	},
	"providerInstanceId": "0123456789",
	"providerLabel": "AZURE",
	"proxyConfiguration": {
		"certificateData": "string",
		"certificateName": "string",
		"deleting": false,
		"enabled": false,
		"proxyHost": "string",
		"proxyIncludedHosts": [
			"string"
		],
		"proxyName": "string",
		"proxyPort": 0,
		"proxyType": "HTTP"
	},
	"reportedProperties": {
		"location": "string",
		"orgId": "string",
		"reportedGatewayDetails": [
			{
				"certUpdateErrorDetails": [
					{
						"cause": "ErrorDetail Object",
						"code": "string",
						"detail": "string",
						"domain": "string",
						"message": "string",
						"parameters": {
							"key": "string"
						}
					}
				],
				"certUpdateStatus": "DELETED",
				"fqdnUpdateErrorDetails": [
					{
						"cause": "ErrorDetail Object",
						"code": "string",
						"detail": "string",
						"domain": "string",
						"message": "string",
						"parameters": {
							"key": "string"
						}
					}
				],
				"fqdnUpdateStatus": "DELETED",
				"gatewayHealthErrorDetails": [
					{
						"cause": "ErrorDetail Object",
						"code": "string",
						"detail": "string",
						"domain": "string",
						"message": "string",
						"parameters": {
							"key": "string"
						}
					}
				],
				"gatewayHealthStatus": "ERROR",
				"gatewayId": "string",
				"proxyUpdateErrorDetails": [
					{
						"cause": "ErrorDetail Object",
						"code": "string",
						"detail": "string",
						"domain": "string",
						"message": "string",
						"parameters": {
							"key": "string"
						}
					}
				],
				"proxyUpdateStatus": "DELETED"
			}
		],
		"uagDeploymentId": "string",
		"updatedAt": "string",
		"version": 0
	},
	"resourceTags": {
		"key": "string"
	},
	"sslCertificateCredentialId": "string",
	"sslCertificateTO": {
		"credentialId": "string",
		"expiryDate": "string",
		"sslCertificateType": "PEM"
	},
	"status": "PENDING",
	"type": "EXTERNAL | INTERNAL_AND_EXTERNAL",
	"updatedAt": "string",
	"version": 0
}

string as date-time

createdAt Optional

Record creation timestamp

string

description Optional

array of ErrorDetail

errorDetails Optional

List of Error Details

string

fqdn Optional

Admin-defined FQDN of the UAG cluster

array of UAGVmDetails

gateways Optional

List of UAG VMs and their details which are deployed

HDC

hdc Optional

string

id Optional

map of InfrastructureResource

infrastructure Optional

Other infrastructure resources for the deployment. The keys in this map and the interpretation of the values depend on the provider type.

UAGLoadBalancer

loadBalancer Optional

string

location Optional

location

string

name Optional

User defined name for this instance

integer as int32

numberOfGateways Optional

Number of Gateways needed in the UAG deployment cluster

string

orgId Optional

Org ID that owns this record

string

passwordCredentialId Optional

CredentialId where the Gateway password is stored.

UAGLoadBalancer

privateLoadBalancer Optional

string

providerInstanceId Optional

Provider instance to where this UAG deployment is deployed

string

providerLabel Optional

Provider label (provider of which this is an instance)

UAGProxyConfig

proxyConfiguration Optional

UAGDeploymentReported

reportedProperties Optional

map of string

resourceTags Optional

Resource tags that are added to UAG deployment

string

sslCertificateCredentialId Optional

CredentialId where the SSL certificate is stored.

SSLCertificateTO

sslCertificateTO Optional

string

status Optional

The configured status of the UAG Cluster deployment

Possible values are: DELETED , DELETE_PENDING , DELETING , DELETION_FAILED , DEPLOYING , FAILED , PENDING , READY , UPDATE_FAILED , UPDATE_PENDING , UPDATING , UPGRADE_FAILED , UPGRADE_PENDING , UPGRADING

string

type Optional

UAG deployment type

Possible values are: EXTERNAL , INTERNAL_AND_EXTERNAL

string as date-time

updatedAt Optional

Record updated timestamp

integer as int64

version Optional

Record version (internal)

Errors

ErrorResponse

401

Unauthorized

ErrorResponse

403

Forbidden

ErrorResponse

404

Not Found

ErrorResponse

409

Conflict - deployment in use

ErrorResponse

500

Unexpected internal server error

Code Samples

cURL Command

curl -X DELETE https://cloud.vmwarehorizon.com/admin/v2/uag-deployments/{id}/proxy-configuration

[{"label":"Latest (V1)","version":"latest"}]

horizon-cloud-nextgen

Admin Operations

post

Create

delete

Delete Proxy Config In Uag Deployment

delete

Delete Uag Deployment

get

Get All Uag Deployments

get

Get Uag Deployment By ID

patch

Patch Uag Deployment

post

Upgrade Uag Deployment

Delete Proxy Config In Uag Deployment

Request

URL

Path Parameters

Query Parameters

Authentication

Bearer

Response

Response Body

Errors

Code Samples

cURL Command

On This Page

Admin Operations

Was this page helpful?