Page tree

Overview

This API call only applies to Armor Complete users.

The Get IPs API retrieves a list of IP addresses allocated to the account. This API also displays how these IP addresses are assigned.  

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



Sample request

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

Input

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

API Call / URLMethod / Type
/ipsGET

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

ParameterDescriptionFormatRequired or optionalExample
locationName

The location of the virtual machine associated with the IP address

(You can use the Get Locations API to find a list of locations.)

StringOptionalDFW01
typeEnum of private4, public4StringOptionalprivate4
StateAn IP address can be Routed, Reserved, or Assigned.StringOptionalReserved

Sample return

StatusResponse
200
{
   "id": 515,
   "location": "DFW01 ",
   "zone": "DFW01-VC01",
   "ip": "100.64.0.9",
   "state": "Reserved",
   "type": "private4",
   "assignedTo": null
 },
 {
   "id": 518,
   "location": "DFW01 ",
   "zone": "DFW01-VC01",
   "ip": "100.64.0.10",
   "state": "Assigned",
   "type": "private4",
   "assignedTo": {
     "id": 1,
     "type": "vm",
     "name": "Smoke-Test-A1",
     "assignmentType": "primary"
      }
 }
400
Bad Request