Virtual Appliances
The Umbrella Virtual Appliances API enables you to:
- List the virtual appliances
- Get a virtual appliance
- Update a virtual appliance
- Delete a virtual appliance
List Virtual Appliances
List the Virtual Appliances, domain controllers, and Active Directory (AD) connectors.
GET /organizations/{organizationId}/virtualappliances
Request Query Parameters
| Name | Type | Description |
|---|---|---|
| page | integer | Specifies a page number in the collection. |
| limit | integer | Specifies the number of records to return per page. |
Request
curl -i -X GET "https://management.api.umbrella.com/v1/organizations/{organizationId}/virtualappliances" \
-H 'Authorization: Basic %YourEncodedKeySecret%' \
-H 'Content-Type: application/json'
Response
Sample response (200, OK):
[
{
"originId": 1234,
"name": "Name of VA",
"siteId": 1,
"isUpgradable": true,
"state": {
"connectedToConnector": "VA connector status",
"hasLocalDomainConfigured": "VA local domain configuration",
"queryFailureRateAcceptable": "VA query failure rate acceptable",
"receivedInternalDNSQueries": "VA received internal DNS queries",
"redundantWithinSite": "VA redundant within site",
"syncing": "VA syncing"
},
"health": "VA health",
"type": "Type of VA",
"settings": {
"internalIPs": [ "internal IP" ],
"externalIP": "external IP",
"hostType": "host type",
"uptime": 1,
"isDnscryptEnabled": true,
"version": "Version of VA",
"upgradeError": "Upgrade error",
"domains": [ "domain name" ],
"lastSyncTime": "2020-03-09T22:18:26.625Z"
},
"createdAt": "2020-03-09T22:18:26.625Z",
"modifiedAt": "2020-03-09T22:18:26.625Z",
"stateUpdatedAt": "2020-03-09T22:18:26.625Z"
}
]
Get a Virtual Appliance
Find a Virtual Appliance.
GET /organizations/{organizationId}/virtualappliances/{virtualApplianceId}
Request Path Parameters
| Name | Type | Description |
|---|---|---|
| organizationId | integer | The organization ID. Required |
| virtualApplianceId | integer | The origin ID (originId) of the Virtual Appliance. Required |
Request
curl -i -X GET "https://management.api.umbrella.com/v1/organizations/{organizationId}/virtualappliances/{virtualApplianceId}" \
-H 'Authorization: Basic %YourEncodedKeySecret%' \
-H 'Content-Type: application/json'
Response
Sample response (200, OK):
{
"originId": 1234,
"name": "Name of virtual appliance",
"isUpgradable": true,
"health": "VA health",
"type": "Type of virtual appliance",
"stateUpdatedAt": "2022-03-09T22:18:26.625Z"
}
Update a Virtual Appliance
Update the site ID of the Virtual Appliance.
PUT /organizations/{organizationId}/virtualappliances/{virtualApplianceId}
Request Path Parameters
| Name | Type | Description |
|---|---|---|
| organizationId | integer | The organization ID. Required |
| virtualApplianceId | integer | The origin ID (originId) of the Virtual Appliance. Required |
Request Body Fields
| Name | Type | Description |
|---|---|---|
| siteId | string | The site ID of the Virtual Appliance. Required |
Request
curl -i -X PUT "https://management.api.umbrella.com/v1/organizations/{organizationId}/virtualappliances/{virtualApplianceId}" \
-H 'Authorization: Basic %YourEncodedKeySecret%' \
-H 'Content-Type: application/json' \
-d '{
"siteId": "A site ID"
}'
Response
Sample response (200, OK):
{
"originId": 1234,
"name": "Name of virtual appliance",
"isUpgradable": true,
"health": "VA health",
"type": "Type of virtual appliance",
"stateUpdatedAt": "2022-03-09T22:18:26.625Z"
}