Getting a list of tenant virtual machines
Getting a list of tenant virtual machines
August 2, 2024
ID 259249
Allows you to get a list of all registered tenant virtual machines.
Method:
GET /api/2.0/virtualization/tenants/{tenant ID
}/vms
where:
{
tenant ID
}
– tenant identifier in the Integration Server database (required parameter).
If the request succeeds, the REST API returns a list of virtual machines and the following information about each tenant virtual machine:
<vm id="{
ID in the database
}" biosId={
BIOS ID} created="{
date and time
}" updated="{
date and time
}">
<name>{
name
}</name>
<userData><![CDATA[{
additional information
}]]></userData>
</vm>
where:
{
ID in the database
}
– identifier assigned to the virtual machine in the Integration Server database.{
BIOS ID}
– virtual machine identifier (BIOS ID) in UUID format.created="{
date and time
}"
– date and time when the virtual machine was registered in the Integration Server database in YYYY-MM-DDThh:mm:ss format.updated="{
date and time
}"
– date and time when the virtual machine data was updated in the Integration Server database in YYYY-MM-DDThh:mm:ss format.{
name
}
– virtual machine name.{
additional information
}
– additional information about the virtual machine stored in the Integration Server database.
Return codes:
200 (OK)
– request completed successfully. A list of the tenant virtual machines is returned in the response.403 (Forbidden)
– access to the resource is denied.404 (Not Found) VIRMT_TenantWithSpecifiedIdNotFound
– a tenant 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.