{"type":"api","title":"Get Virtual Appliance","meta":{"id":"/apps/pubhub/media/legacy-umbrella-api/bf58de618cbb72dda8f39b0414ce94c0a15cd467/8e02e061-a337-3c9a-a76f-a51a8c21291c","swagger":"2.0","info":{"title":"Networks","version":"1.0.0","description":"Networks, Internal Networks, Roaming Computers,\nSites, Virtual Appliances, and Internal Domains","contact":{"name":"Cloud Security Developer Community"}},"host":"management.api.umbrella.com","basePath":"/v1","schemes":["https"],"securityDefinitions":{"http":{"type":"basic"}},"security":[{"http":[]}],"x-parser-conf":{"httpBasic":{"username":"","password":""},"overview":{"markdownPath":"legacy/management/networks-overview.md"},"meta":{"useProxy":true}}},"spec":{"tags":["Virtual Appliances"],"description":"Get a virtual appliance","summary":"Get Virtual Appliance","operationId":"getVirtualAppliance","parameters":[{"name":"organizationId","type":"integer","description":"The organization ID","in":"path","required":true,"$$ref":"#/parameters/orgIdParam"},{"name":"virtualApplianceId","type":"integer","description":"The origin ID (originId) of the virtual appliance","in":"path","required":true,"$$ref":"#/parameters/virtualApplianceIdParam"}],"responses":{"200":{"description":"Get a virtual appliance","schema":{"type":"object","properties":{"originId":{"type":"integer","description":"The origin ID"},"name":{"type":"string","description":"The name of the virtual appliance"},"siteId":{"type":"integer","description":"The site ID"},"isUpgradable":{"type":"boolean","description":"Specifies whether you can upgrade to latest version of VA"},"state":{"additionalProperties":false,"properties":{"connectedToConnector":{"type":"string","description":"Indicates the VA connected to connector status"},"hasLocalDomainConfigured":{"type":"string","description":"Indicates that the VA has local domain configuration"},"queryFailureRateAcceptable":{"type":"string","description":"Indicates that the VA query failure rate is acceptable"},"receivedInternalDNSQueries":{"type":"string","description":"Indicates that the VA received internal DNS queries"},"redundantWithinSite":{"type":"string","description":"Indicates that the VA is redundant within the site"},"syncing":{"type":"string","description":"Indicates that the Va is syncing"}},"type":"object"},"health":{"type":"string","description":"The health of the virtual appliance"},"type":{"type":"string","description":"The type of the virtual appliance"},"settings":{"type":"object","additionalProperties":false,"properties":{"internalIPs":{"type":"array","description":"Internal IPs","items":{"type":"string"}},"externalIP":{"type":"string","description":"External IP"},"hostType":{"type":"string","description":"Host type"},"uptime":{"type":"integer","description":"The uptime in seconds"},"isDnscryptEnabled":{"type":"boolean","description":"Specifies whether DNSCrypt is enabled"},"version":{"type":"string","description":"The version of the virtual appliance"},"upgradeError":{"type":"string","description":"Upgrade error"},"domains":{"type":"array","description":"Domains","items":{"type":"string"}},"lastSyncTime":{"type":"string","format":"date-time","description":"The date and time when the VA was last synced, specified as an ISO 8601 timestamp."}}},"createdAt":{"type":"string","format":"date-time","description":"The date and time when the VA was created, specified as an ISO 8601 timestamp."},"modifiedAt":{"type":"string","format":"date-time","description":"The date and time when the VA was last modified, specified as an ISO 8601 timestamp."},"stateUpdatedAt":{"type":"string","format":"date-time","description":"The date and time when the VA state was updated, specified as an ISO 8601 timestamp."}},"required":["originId","name","isUpgradable","health","type","stateUpdatedAt"],"example":{"originId":1234,"name":"Name of the 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"},"$$ref":"#/definitions/VirtualAppliance"}},"400":{"description":"Validation Error","schema":{"type":"object","minProperties":3,"required":["statusCode","error","txId"],"properties":{"statusCode":{"type":"integer","example":400,"description":"the http error code returned."},"error":{"type":"string","example":"Validation Error","description":"a brief description of the error"},"txId":{"type":"string","example":"86e189a6-0124-47d3-a32c-25ff3f07deaf","description":"a unique hex number that can be used for debugging"},"validationErrors":{"type":"object","properties":{"someProperty":{"type":"string","example":"must not be empty","description":"the name of the property failing validation."}}}}},"$$ref":"#/responses/BadRequest"},"401":{"description":"Unauthorized- The authorization header is missing or the token is unauthorized","schema":{"type":"object","minProperties":3,"required":["statusCode","error","txId"],"properties":{"statusCode":{"type":"integer","example":401,"description":"the http error code returned"},"error":{"type":"string","example":"Unauthorized","description":"a brief description of the error"},"txId":{"type":"string","example":"86e189a6-0124-47d3-a32c-25ff3f07deaf","description":"a unique hex number that can be used for debugging"}}},"$$ref":"#/responses/Unauthorized"},"403":{"description":"Forbidden- The token is invalid","schema":{"type":"object","minProperties":1,"required":["message"],"properties":{"statusCode":{"type":"integer","example":403,"description":"the http error code returned"},"error":{"type":"string","example":"Forbidden, Invalid authentication credentials","description":"a brief description of the error"},"txId":{"type":"string","example":"86e189a6-0124-47d3-a32c-25ff3f07deaf","description":"a unique hex number that can be used for debugging"}}},"$$ref":"#/responses/Forbidden"},"404":{"description":"Not Found- A resource specified in the URL was not found","schema":{"type":"object","minProperties":3,"required":["statusCode","error","txId"],"properties":{"statusCode":{"type":"integer","example":404,"description":"the http error code returned"},"error":{"type":"string","example":"Not Found","description":"a brief description of the error"},"txId":{"type":"string","example":"86e189a6-0124-47d3-a32c-25ff3f07deaf","description":"a unique hex number that can be used for debugging"}}},"$$ref":"#/responses/NotFound"},"500":{"description":"Error- This request could not be processed by the server","schema":{"type":"object","minProperties":3,"required":["statusCode","error","txId"],"properties":{"statusCode":{"type":"integer","example":500,"description":"the http error code returned."},"error":{"type":"string","example":"Internal Server Error","description":"a brief description of the error"},"txId":{"type":"string","example":"86e189a6-0124-47d3-a32c-25ff3f07deaf","description":"a unique hex number that can be used for debugging"}}},"$$ref":"#/responses/ServerError"}},"__originalOperationId":"getVirtualAppliance","security":[{"http":[]}],"consumes":["application/json"],"produces":["application/json"],"method":"get","path":"/organizations/{organizationId}/virtualappliances/{virtualApplianceId}"}}