Create
DescriptionCreated a new UAG deployment: initiates the deployment process
Request
URLURL
Request Body
{
"description": "UAG Deployment description",
"fqdn": "www.example.com",
"name": "My UAG Deployment",
"numberOfGateways": 2,
"orgId": "0123456789",
"providerInstanceId": "0123456789",
"type": "EXTERNAL | INTERNAL | 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
Authentication
Response
Response BodyResponse Body
201 Created
Successfully create UAG Deployment
{
"edgeDeploymentId": "1234",
"fqdn": "www.example.com",
"location": "US",
"name": "My Instance Name",
"numberOfGateways": 2,
"orgId": "0123456789",
"providerInstanceId": "0123456789",
"providerLabel": "AZURE",
"status": "PENDING",
"type": "EXTERNAL | INTERNAL | INTERNAL_AND_EXTERNAL"
}
Record creation timestamp
Edge Deployment id
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 , PARTIALLY_READY , PENDING , READY , UPDATE_FAILED , UPDATE_PENDING , UPDATING , UPGRADE_FAILED , UPGRADE_PENDING , UPGRADING
UAG deployment type
Record updated timestamp
Record version (internal)
Errors
Bad Request
Unauthorized
Forbidden
Not Found
Conflict
Provider disabled
Unexpected internal server error
Code Samples
cURL Command
Vendor Extensions
x-codegen-request-body-name: newUAGDeployment
