Update Virtual Appliance - Cloud Security API

{"type":"api","title":"Update Virtual Appliance","meta":{"id":"/apps/pubhub/media/cloud-security-apis-in-eft/00a46a2c8e43524671a57a4646182a5e94042916/3736e458-8de1-3c2b-bd64-8aa8d676dd57","info":{"title":"Cisco Umbrella Virtual Appliances API","version":"2.0.0","description":"Manage the virtual appliances in your organization.","contact":{"name":"Cloud Security Developer Community"}},"security":[{"oauthFlow":[]}],"tags":[{"name":"Virtual Appliances"},{"name":"Umbrella"}],"x-parser-conf":{"overview":{"markdownPath":"reference/deployments/virtual-appliances-overview.md","uri":"umbrella-api-reference-virtual-appliances-overview"}},"openapi":"3.0.1","servers":[{"url":"https://api.umbrella.com/{basePath}","variables":{"basePath":{"default":"deployments/v2"}}}],"securitySchemes":{"oauthFlow":{"type":"oauth2","description":"The client credential flow.","flows":{"clientCredentials":{"tokenUrl":"https://api.umbrella.com/auth/v2/token","scopes":{"deployments.virtualappliances:write":"Write deployments virtual appliances","deployments.virtualappliances:read":"Read deployments virtual appliances"}}}}}},"spec":{"tags":["Virtual Appliances","Umbrella"],"description":"Update a virtual appliance in the organization.","summary":"Update Virtual Appliance","operationId":"updateVirtualAppliance","security":[{"oauthFlow":["deployments.virtualappliances:write"]}],"parameters":[{"name":"virtualApplianceId","schema":{"type":"integer"},"description":"The origin ID (originId) of the virtual appliance.","in":"path","required":true,"example":135678,"$$ref":"#/components/parameters/virtualApplianceId"}],"requestBody":{"content":{"application/json":{"schema":{"properties":{"siteId":{"type":"integer","description":"The ID of the site.","minimum":1}},"type":"object","required":["siteId"]},"example":{"siteId":10}}},"description":"Update the virtual appliance.","required":true},"responses":{"200":{"description":"OK","headers":{"Content-Type":{"schema":{"type":"string"},"description":"The MIME content type of the response body.","example":"application/json","$$ref":"#/components/headers/Content-Type"},"Date":{"schema":{"type":"string","pattern":"^[0-90-90-90-9-0-90-9-0-90-9T0-90-9:0-90-9:0-90-9Z]+$"},"description":"The timestamp of the response.","example":"2023-03-14T18:34:25Z","$$ref":"#/components/headers/Date"}},"content":{"application/json":{"schema":{"type":"object","description":"The properties of the virtual appliance.","properties":{"originId":{"type":"integer","description":"The origin ID of the virtual appliance."},"name":{"type":"string","description":"The name of the virtual appliance."},"siteId":{"type":"integer","description":"The site ID of the virtual appliance."},"isUpgradable":{"type":"boolean","description":"Specifies whether you can upgrade the virtual appliance (VA) to the latest VA version."},"state":{"additionalProperties":false,"type":"object","description":"The properties for the state of the virtual appliance.","properties":{"connectedToConnector":{"type":"string","description":"The virtual appliance that is connected to the connector status."},"hasLocalDomainConfigured":{"type":"string","description":"The virtual appliance has local domain configuration."},"queryFailureRateAcceptable":{"type":"string","description":"The failure rate of the query for the virtual appliance is acceptable."},"receivedInternalDNSQueries":{"type":"string","description":"The virtual appliance received internal DNS queries."},"redundantWithinSite":{"type":"string","description":"The virtual appliance is redundant within site."},"syncing":{"type":"string","description":"The virtual appliance is syncing."}}},"health":{"type":"string","description":"A description of the health of the virtual appliance."},"type":{"type":"string","description":"The type of the virtual appliance."},"settings":{"type":"object","description":"The properties of the settings on the virtual appliance.","additionalProperties":false,"properties":{"internalIPs":{"type":"array","description":"A list of internal IP addresses.","items":{"type":"string"}},"externalIP":{"type":"string","description":"The external IP address."},"hostType":{"type":"string","description":"The type of the host."},"uptime":{"type":"integer","description":"The uptime in seconds."},"isDnscryptEnabled":{"type":"boolean","description":"Specifies whether DNSCrypt is enabled."},"version":{"type":"string","description":"Specifies the version of the virtual appliance."},"upgradeError":{"type":"string","description":"Specifies the upgrade error."},"domains":{"type":"array","description":"The list of domains.","items":{"type":"string"}},"lastSyncTime":{"type":"string","format":"date-time","description":"The date and time (ISO8601 timestamp) of the last sync.","example":"2018-06-13T16:07:07.222Z"}}},"createdAt":{"type":"string","format":"date-time","description":"The date and time (ISO8601 timestamp) when the VA was created.","example":"2018-06-13T16:07:07.222Z"},"modifiedAt":{"type":"string","format":"date-time","description":"The date and time (ISO8601 timestamp) when the VA was modified.","example":"2018-06-13T16:07:07.222Z"},"stateUpdatedAt":{"type":"string","format":"date-time","description":"The date and time (ISO8601 timestamp) when the virtual appliance's state was updated.","example":"2018-06-13T16:07:07.222Z"}},"required":["originId","name","isUpgradable","health","type","stateUpdatedAt"],"example":{"originId":1234,"name":"Name of the VA","isUpgradable":true,"health":"VA health","type":"Type of VA","stateUpdatedAt":"2020-03-09T22:18:26.625Z"},"$$ref":"#/components/schemas/VirtualApplianceObject"},"example":{"originId":1234,"name":"Name of the VA","isUpgradable":true,"health":"VA health","type":"Type of VA","stateUpdatedAt":"2020-03-09T22:18:26.625Z"}}}},"400":{"description":"Bad Request","headers":{"Content-Type":{"schema":{"type":"string"},"description":"The MIME content type of the response body.","example":"application/json","$$ref":"#/components/headers/Content-Type"},"Date":{"schema":{"type":"string","pattern":"^[0-90-90-90-9-0-90-9-0-90-9T0-90-9:0-90-9:0-90-9Z]+$"},"description":"The timestamp of the response.","example":"2023-03-14T18:34:25Z","$$ref":"#/components/headers/Date"}},"content":{"application/json":{"schema":{"type":"object","properties":{"statusCode":{"type":"integer","example":400,"description":"HTTP status code"},"error":{"type":"string","example":"Validation Error","description":"A brief description of the error"},"message":{"type":"string","description":"Detailed error message"}}}}},"$$ref":"#/components/responses/400Error"},"401":{"description":"Unauthorized","headers":{"Content-Type":{"schema":{"type":"string"},"description":"The MIME content type of the response body.","example":"application/json","$$ref":"#/components/headers/Content-Type"},"Date":{"schema":{"type":"string","pattern":"^[0-90-90-90-9-0-90-9-0-90-9T0-90-9:0-90-9:0-90-9Z]+$"},"description":"The timestamp of the response.","example":"2023-03-14T18:34:25Z","$$ref":"#/components/headers/Date"}},"content":{"application/json":{"schema":{"type":"object","properties":{"statusCode":{"type":"integer","example":401,"description":"HTTP status code"},"error":{"type":"string","example":"Validation error","description":"A brief description of the error"},"message":{"type":"string","description":"Detailed error message"}}}}},"$$ref":"#/components/responses/401Error"},"403":{"description":"Forbidden","headers":{"Content-Type":{"schema":{"type":"string"},"description":"The MIME content type of the response body.","example":"application/json","$$ref":"#/components/headers/Content-Type"},"Date":{"schema":{"type":"string","pattern":"^[0-90-90-90-9-0-90-9-0-90-9T0-90-9:0-90-9:0-90-9Z]+$"},"description":"The timestamp of the response.","example":"2023-03-14T18:34:25Z","$$ref":"#/components/headers/Date"}},"content":{"application/json":{"schema":{"type":"object","properties":{"statusCode":{"type":"integer","example":403,"description":"HTTP status code"},"error":{"type":"string","example":"Forbidden","description":"A brief description of the error"},"message":{"type":"string","description":"Detailed error message"}}}}},"$$ref":"#/components/responses/403Error"},"404":{"description":"Not Found","headers":{"Content-Type":{"schema":{"type":"string"},"description":"The MIME content type of the response body.","example":"application/json","$$ref":"#/components/headers/Content-Type"},"Date":{"schema":{"type":"string","pattern":"^[0-90-90-90-9-0-90-9-0-90-9T0-90-9:0-90-9:0-90-9Z]+$"},"description":"The timestamp of the response.","example":"2023-03-14T18:34:25Z","$$ref":"#/components/headers/Date"}},"content":{"application/json":{"schema":{"type":"object","properties":{"statusCode":{"type":"integer","example":404,"description":"HTTP status code"},"error":{"type":"string","example":"Not Found","description":"A brief description of the error"},"message":{"type":"string","description":"Detailed error message"}}}}},"$$ref":"#/components/responses/404Error"},"500":{"description":"Internal Server Error","headers":{"Content-Type":{"schema":{"type":"string"},"description":"The MIME content type of the response body.","example":"application/json","$$ref":"#/components/headers/Content-Type"},"Date":{"schema":{"type":"string","pattern":"^[0-90-90-90-9-0-90-9-0-90-9T0-90-9:0-90-9:0-90-9Z]+$"},"description":"The timestamp of the response.","example":"2023-03-14T18:34:25Z","$$ref":"#/components/headers/Date"}},"content":{"application/json":{"schema":{"type":"object","properties":{"statusCode":{"type":"integer","example":500,"description":"HTTP status code"},"error":{"type":"string","example":"Internal error","description":"A brief description of the error"},"message":{"type":"string","description":"Detailed error message"}}}}},"$$ref":"#/components/responses/500Error"}},"__originalOperationId":"updateVirtualAppliance","method":"put","path":"/virtualappliances/{virtualApplianceId}"}}