Unregistering a virtual machine

January 10, 2024

ID 199654

Allows you to delete information about the tenant virtual machine from the Integration Server database.

Unregistration does not disable protection of the tenant virtual machine. You can disable protection of the virtual machine for complete tenant type by following all the steps of the procedure for removing virtual machines from the protected infrastructure.

Method:

POST /api/2.0/virtualization/tenants/{tenant ID}/vms/unregister?biosId={ID}

or

POST /api/2.0/virtualization/tenants/{tenant ID}/vms/unregister?vmId={ID}

where:

  • {tenant ID} – tenant identifier in the Integration Server database (required parameter).
  • biosId={ID} – virtual machine identifier (BIOS ID) in UUID format (required parameter).
  • vmId={ID} – virtual machine identifier in the Integration Server database in the UUID format (required parameter).

Return codes:

  • 200 (OK) – request completed successfully (information about the virtual machine is deleted from the Integration Server database).
  • 403 (Forbidden) – access to the resource is denied.
  • 404 (Not Found) VIRMT_TenantWithSpecifiedIdNotFound – tenant with the specified identifier is not found in the Integration Server database.
  • 404 (Not Found) VIRMT_VmWithSpecifiedIdNotFound – virtual machine with the specified identifier is not found in the Integration Server database.

Did you find this article helpful?
What can we do better?
Thank you for your feedback! You're helping us improve.
Thank you for your feedback! You're helping us improve.