Page tree


Knowledge Base


Feedback

Have a suggestion for the Armor Knowledge Base?

Send a message to
kb@armor.com.









Overview

The Delete VM API deletes a virtual machine.   

You can use the Get VMs to find the virtual machine ID (id) and account ID (accountId).

Sample Request

DELETE https://api.armor.com/vms/6

{
 "accountId": 2,
 "vmId": 6,
 "userEmail": "test.dev@armor.com",
 "isActive": true,
 "deleteNow": true
}

Input


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

API Call / URLMethod / Type

/vms/{id}

DELETE


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

ParameterDescriptionRequired or optionalTypeExample
idThe ID of the virtual machineRequiredInteger6
accountIdThe ID of the AMP account.RequiredInteger2
vmIdThe ID of the virtual machineRequiredInteger6
userEmailThe email address (AMP username) for the account holder.RequiredStringtest.dev@armor.com
isActiveThe status of the virtual machineRequiredBooleantrue
deleteNowThe desire to delete the virtual machine immediatelyRequiredBooleantrue

Sample Return

StatusResponse
200
 True
400
Bad Request