Page tree




In This Document 


Was this document useful? 
Your Rating:
Results:
1 Star2 Star3 Star4 Star5 Star
2 rates


Have a suggestion for the Armor Knowledge Base? Send a message to kb@armor.com.



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

The following table describes the different parts of this API call: 

API Call / URLMethod / Type

/vms

GET

There are no parameters for this API call. 


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

The following table describes the expected results for specific outputs that may not be clear enough within the sample 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

 The following table lists the possible return values for Status:

Numeric valueString valueDescription
-1FAILED_CREATIONThe object could not be created
0UNRESOLVEDThe object is unresolved
1RESOLVEDThe object is resolved
2DEPLOYEDThe object is deployed
3SUSPENDEDThe object is suspended
4POWERED_ONThe object is powered on
5WAITING_FOR_INPUTThe object is waiting for user input
6UNKNOWNThe object is in an unknown state
7UNRECOGNIZEDThe object is in an unrecognized state
8POWERED_OFFThe object is powered off.
9INCONSISTENT_STATEThe object is in an inconsistent state
10MIXEDChildren do not all have the same status
11DESCRIPTION_PENDINGUpload initiated, OVF descriptor pending
12COPYING_CONTENTSUpload initiated, copying contents
13DISK_CONTENTS_PENDINGUpload initiated, disk contents pending
14QUARANTINEDUpload has been quarantined
15QUARANTINE_EXPIREDUpload quarantine period has expired
16REJECTEDUpload has been rejected
17TRANSFER_TIMEOUTUpload transfer session timed out
18VAPP_UNDEPLOYEDThe vApp is resolved and undeployed
19VAPP_PARTIALLY_DEPLOYEDThe vApp is resolved and partially deployed.
100CHANGES_PENDINGThe request has been received, but not completed. 
101COMPLETEThe action has been completed. 
102BUSYThe server is busy and cannot complete the action. Try again. 
103TEMPLATE_PENDINGThe virtual machine template is currently being generated.