Page tree


Knowledge Base


Feedback

Have a suggestion for the Armor Knowledge Base?

Send a message to
kb@armor.com.









Overview

The Create New Virtual Machine API creates a new virtual machine. 

You can use the Get Locations API to find locations to add a new virtual machine. 

Sample Request

POST https://api.armor.com/orders/vms
{
    "name": "NewVirtualMachine",
    "location": "dfw01",
    "appId": -1,
    "appName": "NewWorkload",
    "tierId": -1,
    "tierName": "NewTier",
    "storage": [],
    "secret": "kbwcEFufHBc$j#Z97HWMXdPCss",
    "sku": "A1-101",
    "quantity": 1
}

Input


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

API Call / URLMethod / Type

/orders/vms

POST


The following table describes the parameter (or parameters) for this API call: 

ParameterDescriptionRequired or optionalTypeExample

name

The name of the virtual machineRequiredStringNewVirtualMachine
locationThe data center for the virtual machineRequiredStringdfw01
appIdThe ID of the workload for the virtual machine

Required

(You must enter a value if appName is null.)

Integer-1
appNameThe name of the new workload that will contain the virtual machine

Required

(You must enter aa value if appId is null.)

StringNewWorkload
tierIdThe ID for the virtual machine

Required

(You must enter a value if tierName is null.)

Integer-1
tierNameThe name of a new tier that will contain the virtual machine

Required

(You must enter a value if tierId is null.)

StringNewTier
disks

The array for additional disks (also known as storage) for the virtual machine

OptionalStorageOrderItem[]
secret

The password to the virtual machine

(This password must contain at least one upper-case letter, one lower-case letter, a number, and special character. Additionally, this password must be at least 16 characters in legnth.)

RequiredStringkbwcEFufHBc$j#Z97HWMXdPCss
skuThe product identifier for the virtual machineRequiredStringA1-101
quantityThe quantity of virtual machines to order

Required

(You must enter 1.)
Integer1

Sample Return

StatusResponse
200
{
 "id": 33,
 "accountId": 2,
 "status": "submitted",
 "dateCreated":"2015-01-07T02:21:00.00000Z",
 "vms": [
      {
      "trackingId": "00000000-0000-0000-0000-000000000000"
    "name": "NewVirtualMachine",
    "location": "dfw01",
    "zone": null,
    "appId": -1,
    "appName": "NewWorkload",
    "tierId": -1,
    "tierName": "NewTier",
    "storage": [
       {
 		"size": 30,
   		"sku": "SAN-001",
      "quanity":0,
        "accountId":0
       }
    ],
    "software": [
      {
        "sku": "CentOS 6",
      "parameters": [],
        "type":"os",
      "quanity":0,
         "accountId":0
      }
    ],
    "secret": null,
    "sku": "A1-101",
    "quantity": 1,
      "accountId": 0
  }
 ]
}   
400
 {
"error": true,
"message": "Invalid request"
}

Output


The following table describes the expected results for specific outputs that may not be clear enough within the sample output.

ReturnTypeDescriptionPossible valuesExample
SecretStringThe password to your virtual machine. For security reasons, this password is hidden.nullnull