Overview

The Get VMs API displays a list of virtual machines in your account. 

This API also displays any schedule events associated with the virtual machine, such as a scheduled downgrade. 

You can use this API to find the virtual machine ID. You will need this ID for other virtual machine-related APIs. 

Sample request

GET https://api.armor.com/vms

Input

API Call / URLMethod / Type

/vms

GET



Sample return

StatusResponse
200
[
  {
    "coreInstanceId": "06daafab-bffb-4f81-8cbf-532faad97037",
    "dateCreated": null,
    "providerRefId": null,
    "provider": "Complete",
    "hostName": null,
    "externalAddress": null,
    "isRegistered": null,
    "dateRegistered": null,
    "lastPing": null,
    "needsReboot": null,
    "customProvider": null,
    "customLocation": null,
    "instanceType": null,
    "status": 0,
    "isCore": true,
    "externalVmIsDeleted": null,
    "accountId": 98345,
    "vmId": 21309821,
    "workLoadId": 1232,
    "workLoadName": "General Dynamics Web",
    "location": "DFW01",
    "operatingSystem": "CentOS 6.7",
    "isArmor": true,
    "ipAddress": "100.64.0.120",
    "zone": "DFW01-CD01",
    "name": "Website Public",
    "cpu": 1,
    "memory": 2048,
    "storage": 81920,
    "statusId": 4,
    "deployed": true,
    "vcdOrgVdcId": 0,
    "isRecoveryVm": false,
    "product": {
      "sku": "A1-101",
      "size": "A1",
      "isExpired": false,
      "storagePolicyClass": null
    },
    "tags": [],
    "scheduledEvents": [],
    "vmServices": null,
    "multiVmVapp": false
  }
]        	
400
Bad Request



Output

ReturnTypeDescriptionPossible valuesExample
statusIntegerThe state of the object

A range of numbers from -1 to 19

(See Note below for possible values)

0
taskDateDate and timeThe date and time, in combined date and time format (ISO 8601), of when the event will take place Any date and time2016-09-01T00:00:00
maitenanceWindowIntegerA countdown of when the event will take placeAny value in minutes60