Create
DescriptionCreated a new UAG deployment: initiates the deployment process
Request
URLURL
Request Body
{
"description": "UAG Deployment description",
"fqdn": "www.example.com",
"infrastructure": {
"key": {
"data": {},
"id": "string",
"infrastructureLinks": {},
"kind": "string"
}
},
"name": "My UAG Deployment",
"numberOfGateways": 2,
"orgId": "0123456789",
"providerInstanceId": "0123456789",
"proxyConfiguration": {
"enabled": false,
"proxyHost": "string",
"proxyName": "test-proxy",
"proxyPort": 0,
"proxyType": "HTTP",
"trustedCertificate": "string"
},
"resourceTags": {
"key": "string"
},
"sslCertificate": {
"data": {
"certificate": "string",
"certificatePassword": "string"
},
"type": "PEM|PFX"
},
"type": "EXTERNAL | INTERNAL_AND_EXTERNAL"
}
User defined description for this UAG deployment
Admin-defined FQDN of the UAG cluster
Other infrastructure resources for the deployment. The keys in this map and the interpretation of the values depend on the provider type.
User defined name for this UAG deployment
Number of Gateways needed in the UAG deployment cluster
Org ID that owns this record
Provider instance to where this UAG deployment is deployed
Resource tags that are added to UAG deployment
UAG deployment type
Possible values are: EXTERNAL , INTERNAL_AND_EXTERNAL
Authentication
Response
Response BodyResponse Body
Successfully create 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
}
Record creation timestamp
Admin-defined FQDN of the UAG cluster
Other infrastructure resources for the deployment. The keys in this map and the interpretation of the values depend on the provider type.
location
User defined name for this instance
Number of Gateways needed in the UAG deployment cluster
Org ID that owns this record
CredentialId where the Gateway password is stored.
Provider instance to where this UAG deployment is deployed
Provider label (provider of which this is an instance)
Resource tags that are added to UAG deployment
CredentialId where the SSL certificate is stored.
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
UAG deployment type
Possible values are: EXTERNAL , INTERNAL_AND_EXTERNAL
Record updated timestamp
Record version (internal)
Errors
Code Samples
Code Samples
cURL Command
Vendor Extensions
x-codegen-request-body-name: newUAGDeployment
