Page tree

In This Document 

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

Have a suggestion for the Armor Knowledge Base? Send a message to


This API call only applies to Armor Complete users.

The Assign IP API assigns an IP address to a virtual machine.  

You can use the Get VMs API to find the virtual machine ID (vmId). 

You can use the Get IPs API to find the IP ID (id).

Sample request

 "vmId": 1,
 "id": 518,
 "accountId": 2


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

API Call / URLMethod / Type

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

ParameterDescriptionFormatRequired or optionalExample
vmIdThe VM id to which the IP is assignedIntegerOptional1
idID of the IPIntegerOptional518

Sample return

"The IpAddress has been assigned to Vm Smoke-Test-A1"
Bad Request