List Virtual Machines

List Virtual Machines

Retrieves the list of VM templates.

Request
URI
GET
https://{api_host}/iaas-proxy-provider/api/source-machines
COPY
Query Parameters
string
platformTypeId
Required

The platform type id.

string
actionId
Required

The action id.

boolean
loadTemplates
Optional

Flag to include "isTemplate" in request filter.

integer
page
Optional

Page Number

integer
limit
Optional

Number of entries per page

string
$orderby
Optional

Multiple comma-separated properties sorted in ascending or descending order

integer
$top
Optional

Sets the number of returned entries from the top of the response (total number per page in relation to skip)

integer
$skip
Optional

Sets how many entries you would like to skip

string
$filter
Optional

Boolean expression for whether a particular entry should be included in the response


Responses
200

The virtual machine are retrieved.

[
    {
        "hostName": "string",
        "disks": [
            {
                "name": "string",
                "externalDiskId": "string",
                "id": "string",
                "deviceId": "string",
                "capacity": 0
            }
        ],
        "description": "string",
        "externalId": "string",
        "endpointName": "string",
        "cpu": 0,
        "guestOsFamily": "string",
        "reservationName": "string",
        "parentTemplate": "string",
        "memoryMB": 0,
        "interfaceType": "string",
        "isTemplate": false,
        "name": "string",
        "id": "string",
        "region": "string",
        "properties": [
            {
                "virtualMachineId": "string",
                "isEncrypted": false,
                "name": "string",
                "id": "string",
                "value": "string",
                "isRuntime": false,
                "isHidden": false
            }
        ],
        "status": "string",
        "storageGB": 0
    }
]