Page tree

Versions Compared

Key

  • This line was added.
  • This line was removed.
  • Formatting was changed.

...

Note

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


...

Sample request

Code Block
languagetext
GET https://api.armor.com/ips

...

ParameterDescriptionFormatRequired or optionalExample
locationName (query)

The location

field from the Get location call

of the virtual machine associated with the IP address

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

StringOptionalDFW01
type (query)Enum of private4, public4StringOptionalStatue (query)Enum of private4
StateAn IP address can be Routed, Reserved, or Assigned.StringOptionalReserved


...

Sample return

StatusResponse
200
Code Block
languagetext
{
   "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
Code Block
languagetext
Bad Request


...

Excerpt
hiddentrue

Output

Excerpt Include
Output results (snippet)
Output results (snippet)
nopaneltrue

ReturnTypeDescriptionPossible valuesExample